Serve per-page Markdown for docs and split llms-full.txt by section

Abierto
#238 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
54/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
javascript, react

Línea de trabajo

Start by locating how the website serves documentation pages and generates or publishes llms.txt and llms-full.txt; the issue does not name specific files or tests. Check how existing docs routes and generated text files are built, then verify that every page has a working .md URL with the correct content type, llms.txt links to those URLs, and llms-full.txt is split by section.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

There are no per-page Markdown URLs. AI tools must either parse HTML or download the whole 718 KB llms-full.txt to read a single docs page.

Current behavior

  • /docs/<page>.md does not exist.
  • llms-full.txt is one 718 KB file.

Proposed solution

  1. Serve a Markdown version of every docs page at /docs/<page>.md.
  2. Link those .md URLs from llms.txt.
  3. Split llms-full.txt by section (for example llms-full-advanced-guide.txt, llms-full-guides.txt) and link them from llms.txt.

Acceptance criteria

  • Every docs page has a working .md URL with correct content type.
  • llms.txt links to the .md versions.
  • llms-full.txt is split by section.

Why this matters

Small, per-page Markdown cuts token cost and parsing errors for AI tools and coding assistants, and makes answers more accurate.

Additional context

Found in an audit of gofr.dev AI readiness and discoverability on 2026-10-07. Nice-to-have; lower priority than the llms.txt coverage issue.

Lenguaje dominante
JavaScript
Estrellas
44
Forks
44
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de gofr-dev/website

Todos los issues de gofr-dev/website

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.