Docs site: publish docs.stack314.com/neolith from this repo, with a generated API reference
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- markdown, python
- Domain
- build-system, devops, documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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).
- Dominant language
- Python
- Stars
- 1
- Forks
- 0
- Avg merge
- 5h 30m
- Merged PRs (30d)
- 85
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stack314/django-neolith
-
help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
stack314/django-neolith#142 · 1 comment ·
Maintainers usually reply within 1 day
-
help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
stack314/django-neolith#141 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
stack314/django-neolith#140 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
stack314/django-neolith#126 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
stack314/django-neolith#119 · 2 comments ·
Maintainers usually reply within 1 day
All issues in stack314/django-neolith
Similar issues
-
automated endpoint-dead needs-curation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
almanac-data/climate-almanac#138 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
OceanDataTools/openrvdas#760 ·
Maintainers usually reply within 1 day
-
level/subtask type/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
wazuh/wazuh-virtual-machines#1091 ·
Maintainers usually reply within 1 day
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContentPossibly taken @halcyon-past claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
microsoft/semantic-kernel#14824 · 1 comment ·
Maintainers usually reply within 3 days
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
LedgerHQ/app-bitcoin-legacy#306 ·