Author the docs plugin's own documentation (dogfood)
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- markdown, typescript
- Ambito
- documentation
Direzione di ricerca
Read the docs plugin implementation and its Velite pipeline, then follow the repository's docs conventions and GLOSSARY.md. Author the plugin guide in the docs tree with the requested frontmatter fields, covering the plugin, build process, adding docs, and OpenAPI/MCP access. Verify the page renders on /docs; completion also depends on blocked issue #447.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Parent
#444
What to build
The docs plugin documents itself, through its own pipeline: author its user- and agent-facing documentation as markdown in the repository's docs tree, then verify it renders on /docs via the plugin's velite pipeline. This is the first real content authored against the new system and the proof the pipeline works for humans writing docs, not just compiling existing ones.
Content to cover: what the plugin is and why (docs-as-code over the repo's existing markdown culture), how content is compiled at build time, the frontmatter schema (title, description, tags, order), how to add a doc, and how agents read the docs via OpenAPI/MCP.
Blocked by: #447
Acceptance criteria
- The plugin's documentation page renders on
/docsthrough the plugin's own pipeline - Content follows repo docs conventions (kebab-case naming, GLOSSARY.md vocabulary)
- Frontmatter demonstrates the full schema (tags, order) so the index view is exercised
- Lingua principale
- TypeScript
- Stelle
- 5
- Fork
- 3
- Merge medio
- 12h 42m
- PR unite (30g)
- 72
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di NEARBuilders/everything-dev
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
NEARBuilders/everything-dev#400 ·
I maintainer di solito rispondono entro 1 giorno
-
ready-for-agent
Difficoltà 4/5 3-5 giorni Idoneità per principianti 43/100
NEARBuilders/everything-dev#448 ·
I maintainer di solito rispondono entro 1 giorno
-
ready-for-agent
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
NEARBuilders/everything-dev#447 ·
I maintainer di solito rispondono entro 1 giorno
-
ready-for-agent
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
NEARBuilders/everything-dev#446 ·
I maintainer di solito rispondono entro 1 giorno
-
ready-for-agent
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
NEARBuilders/everything-dev#445 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di NEARBuilders/everything-dev
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
chrisparsons83/flexspotff#215 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
vitest-dev/vitest#11633 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
I maintainer di solito rispondono entro 1 giorno