docs: a documentation site built from docs/

Open
#331 0 comments 0 reactions 0 assignees View on GitHub

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

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

area: core

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 main in 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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from public/ducat

All issues in public/ducat

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.