Author the docs plugin's own documentation (dogfood)
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- markdown, typescript
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- TypeScript
- Estrellas
- 5
- Forks
- 3
- Merge medio
- 12 h 42 min
- PR fusionados (30 d)
- 72
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NEARBuilders/everything-dev
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NEARBuilders/everything-dev#400 ·
Los mantenedores suelen responder en 1 día
-
ready-for-agent
Dificultad 4/5 3-5 días Aptitud para principiantes 43/100
NEARBuilders/everything-dev#448 ·
Los mantenedores suelen responder en 1 día
-
Public docs UI — browse + readAbiertoready-for-agent
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
NEARBuilders/everything-dev#447 ·
Los mantenedores suelen responder en 1 día
-
ready-for-agent
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
NEARBuilders/everything-dev#446 ·
Los mantenedores suelen responder en 1 día
-
ready-for-agent
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
NEARBuilders/everything-dev#445 ·
Los mantenedores suelen responder en 1 día
Todos los issues de NEARBuilders/everything-dev
Issues similares
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
components-web-app/docs#260 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100
521xueweihan/HelloGitHub#4025 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
ctrf-io/playwright-ctrf-json-reporter#117 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
voidzero-dev/void#478 ·
Los mantenedores suelen responder en 1 día