Docs site: publish docs.stack314.com/neolith from this repo, with a generated API reference
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- markdown, python
- Ambito
- build-system, devops, documentation
Direzione di ricerca
Start by reading the URL contract, site rules, and the proposed phases in this issue, then review the existing site in the lab website repo and the source documents under spec/, docs/adr/, and docs/. First resolve the open generator and publishing design debate; phase 1 is gated on #53 and acceptance of #56, while generated reference and release triggers are phase 2. Done means the agreed phases preserve the listed URLs and site rules and meet their build and publication requirements.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Neolith's user documentation at docs.stack314.com/neolith/ becomes the Neolith team's to build and publish. The webmaster keeps the hostname, routing, headers and DNS.
What exists
- An Astro Starlight site in the lab's website repo (
sites/docs/). It holds a hand-synced copy of this repo's Markdown at 14309e7: spec, ADRs, VISION, CONTRIBUTING, CHANGELOG and thedocs/pages. - A public URL contract, kept as it is:
/neolith/,/neolith/spec/<NN-name>/,/neolith/decisions/<NNNN-slug>/,/neolith/project/<page>/,/neolith/reference/..., plusllms.txt. Every URL ends in a slash, a moved page gets a 301, and slugs come from file names, so renaming a spec or ADR file needs a redirect. - Site rules, kept as they are:
- Be honest about status.
- Site-written text names no people.
- Site-written text says nothing about how the code is written; mirrored repo documents stay word for word.
- Refuse any synced file that contains an email address.
- Keep the trademark footer.
- Pages must read without JavaScript.
Proposed position (open to the design debate before work starts)
- Move the site into this repo (the handover's option A): a
website/folder, built by Cloudflare Workers Builds from this repo and served at/neolith/through Astro'sbase. The site then readsspec/anddocs/adr/directly, with no copy step and no webmaster in the loop. Builds run on Cloudflare, so they cost no GitHub Actions minutes. - Generate the API reference, don't write it:
- Pages come from docstrings and type hints on the public API (
neolith.__all__), extracted with griffe at build time into/neolith/reference/. - Spec and ADRs are published as written; reference pages link to the requirement IDs and decisions they implement.
- Tutorials and how-tos are hand-written and stay honest stubs until something is installable.
- Pages come from docstrings and type hints on the public API (
- Docstring discipline: one style (Google), enforced by ruff's docstring rules on the public API, and a strict docs build that fails on a broken link or a missing docstring.
- Generator: keep Starlight unless the debate finds a blocker. MkDocs Material + mkdocstrings would do the Python reference natively, but it means rebuilding a working site and its URL contract, and its long-term maintenance needs checking first. Weigh both; don't settle it by habit.
- Publish trigger:
- Until 0.1, publish from
main, with each page stating draft status. - From the first release, production moves to a branch that advances only on release, with
mainas a noindex preview. - Versioned docs (per release) once there is more than one release.
- Until 0.1, publish from
When to act
- Phase 1 (move, direct reads, build check, docstring lint): after step 3 closes (#53) and the step 4 records are accepted (#56), running beside step 4's PRs. Starting the lint early keeps the docstring backfill small.
- Phase 2 (generated reference, release trigger, versions): before step 8 (#15), the 0.1 proof.
Human-only steps (@vignzpie)
- Install the Cloudflare GitHub app on this repo when phase 1's PR is ready.
- Confirm the publish trigger above.
The webmaster connects the Worker and routes docs.stack314.com/neolith/* (handover steps 6–9).
- Lingua principale
- Python
- Stelle
- 1
- Fork
- 0
- Merge medio
- 5h 30m
- PR unite (30g)
- 85
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di stack314/django-neolith
-
help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
stack314/django-neolith#142 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
stack314/django-neolith#141 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
stack314/django-neolith#140 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
stack314/django-neolith#126 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
stack314/django-neolith#119 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di stack314/django-neolith
Issue simili
-
automated endpoint-dead needs-curation
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
almanac-data/climate-almanac#138 ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 67/100
OceanDataTools/openrvdas#760 ·
I maintainer di solito rispondono entro 1 giorno
-
level/subtask type/enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
wazuh/wazuh-virtual-machines#1091 ·
I maintainer di solito rispondono entro 1 giorno
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContentForse già presa @halcyon-past l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
microsoft/semantic-kernel#14824 · 1 commento ·
I maintainer di solito rispondono entro 3 giorni
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
LedgerHQ/app-bitcoin-legacy#306 ·