docs: a documentation site built from docs/

Aperta
#331 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
43/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github-actions, markdown, typescript, vite

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
TypeScript
Stelle
0
Fork
0
Merge medio
35m
PR unite (30g)
242

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di public/ducat

Tutte le issue di public/ducat

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.