docs: a documentation site built from docs/
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 43/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- github-actions, markdown, typescript, vite
- Domain
- ci-cd, documentation
Research direction
Start with docs/reference/limitations.md and the existing docs/ structure described in the issue; then inspect the repository’s workspace configuration, README, npm page, and CI workflows. Choose a static generator that renders the Markdown unchanged, and check how doctests and link checks can gate a GitHub Pages deploy from main. Done means the site is deployed, linked from both places, the limitation is removed, and site dependencies are isolated in their own workspace package.
Written by the indexing model from the issue text.
Description
From docs/reference/limitations.md (Alex, 2026-11-13: worth doing soon).
docs/ is now in Diátaxis shape (#265), with every example tested. Publish it as a site.
- choose a static generator that renders the existing Markdown as is (VitePress or Starlight), with no content changes needed
- build and deploy to GitHub Pages from
mainin CI, with the doctests and link checks gating the deploy - the README and npm page link to the site; the "No docs site yet" limitation goes
- a size and dependency note: the site's dependencies are in their own workspace package, never in ducat's
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 35m
- Merged PRs (30d)
- 242
Getting set up
- No Dockerfile or Docker Compose file
- No 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 public/ducat
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
public/ducat#349 · 1 comment ·
Maintainers usually reply within 1 day
-
area: tests
Difficulty 3/5 1-2 days Newbie friendliness 56/100
Maintainers usually reply within 1 day
-
area: core
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
-
area: core
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
tintinweb/pi-subagents#459 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
danielmiessler/LifeOS#2830 ·
Maintainers usually reply within 6 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
freshframework/fresh#3920 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
area: client enhancement priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
opensro-dev/opensro#3681 ·
Maintainers usually reply within 1 day