Docs site: publish docs.stack314.com/neolith from this repo, with a generated API reference
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- markdown, python
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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).
- 主要言語
- Python
- スター
- 1
- フォーク
- 0
- 平均マージ
- 5時間 30分
- マージ済み PR(30日)
- 85
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stack314/django-neolith のほかの issue
-
help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
stack314/django-neolith#142 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
stack314/django-neolith#141 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
stack314/django-neolith#140 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
stack314/django-neolith#126 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
stack314/django-neolith#119 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
stack314/django-neolith の issue をすべて見る
似ている issue
-
automated endpoint-dead needs-curation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
almanac-data/climate-almanac#138 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
OceanDataTools/openrvdas#760 ·
メンテナーはふだん 1 日以内に返信
-
level/subtask type/enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
wazuh/wazuh-virtual-machines#1091 ·
メンテナーはふだん 1 日以内に返信
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContent対応中かも @halcyon-past が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
microsoft/semantic-kernel#14824 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
LedgerHQ/app-bitcoin-legacy#306 ·