Publish a documentation site
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- github, github-actions, typescript
- 領域
- ci-cd, documentation
調査の方向性
Read docs/README.md for the audience navigation, then inspect .github/workflows/pages.yml and apps/web/src/sw.ts alongside the referenced offline-first ADR. Choose and document a site generator in an accepted ADR, then build and deploy the docs site through pages.yml, add a CI link check, and verify the player's offline end-to-end tests still pass. Done means search and navigation work on the deployed site, relative links still work on GitHub, and broken links fail CI.
索引モデルが issue の本文から書いたものです。
説明
Context
The documentation is Markdown in the repository, read on GitHub. Authors, many of them not developers, need a navigable and searchable site, and the frozen spec is the main public contract at v1.0.
Scope
- A static site built from docs/ (spec, authoring guide, generation pipeline, architecture, ADRs, changelog) with search, deployed with the player on GitHub Pages under a docs/ path.
- The Markdown files stay the only source; relative links keep working on GitHub.
- The site generator is a new build dependency and gets a short ADR.
- The player's service worker does not precache or intercept the docs paths.
- Build in pages.yml; a link check in CI.
Acceptance criteria
- The ADR on the site generator is accepted.
- The site is deployed with the player, with navigation by audience as in docs/README.md, and search works.
- A broken relative link fails CI.
- The player's offline end-to-end tests still pass.
References
- docs/README.md
- .github/workflows/pages.yml
- apps/web/src/sw.ts
- docs/adr/0006-offline-first-pwa-on-github-pages.md
- 主要言語
- TypeScript
- スター
- 0
- フォーク
- 0
- 平均マージ
- 28分
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
nullthrone/lexvm のほかの issue
-
area: web good first issue priority: low type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
nullthrone/lexvm#49 ·
-
area: infra good first issue priority: low type: chore
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
nullthrone/lexvm#41 ·
-
area: engine good first issue priority: low type: feature
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
nullthrone/lexvm#27 ·
-
area: web priority: low type: research
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
nullthrone/lexvm#63 ·
-
area: infra area: web priority: medium type: chore
難易度 5/5 1週間以上 初心者へのやさしさ 38/100
nullthrone/lexvm#62 ·
nullthrone/lexvm の issue をすべて見る
似ている issue
-
area:plugins area:security area:skills bug has repro
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
anthropics/claude-code#105911 ·
メンテナーはふだん 1 日以内に返信
-
openspec-apply-change skill: when blocked, may select a ready artifact unrelated to missingArtifactsオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Fission-AI/OpenSpec#2165 ·
メンテナーはふだん 1 日以内に返信
-
🐞 bug 🧐 unconfirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
Tencent/tdesign-vue-next#7032 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
gnosis/gnosis_vpn#661 ·
メンテナーはふだん 1 日以内に返信
-
content-freshness: staleOwnedContent doc comments still say 'complete receipt' (follow-up to #7912)オープンtriage:bug-verified
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
メンテナーはふだん 1 日以内に返信