Publish a documentation site
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github, github-actions, typescript
- Domain
- ci-cd, documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 28m
- Merged PRs (30d)
- 2
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 nullthrone/lexvm
-
area: web good first issue priority: low type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
nullthrone/lexvm#49 ·
-
area: infra good first issue priority: low type: chore
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
nullthrone/lexvm#41 ·
-
area: engine good first issue priority: low type: feature
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
nullthrone/lexvm#27 ·
-
area: web priority: low type: research
Difficulty 5/5 Over a week Newbie friendliness 35/100
nullthrone/lexvm#63 ·
-
area: infra area: web priority: medium type: chore
Difficulty 5/5 Over a week Newbie friendliness 38/100
nullthrone/lexvm#62 ·
All issues in nullthrone/lexvm
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
openclaw/openclaw#182077 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
aikido high security
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
dequelabs/axe-linter-action#161 ·
-
[Feature Request] Update the DimCode agent icon to the 45:32 brand markPossibly taken @eric8810 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
lyswhut/lx-music-desktop#3026 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
abhigyanpatwari/GitNexus#3704 ·
Maintainers usually reply within 1 day