docs(docs): link repository files from /docs now that the repository is public

Abierto Apto para principiantes
  • ¿Algo no está bien?
#462 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
nextjs, playwright, react, typescript
Área
documentation, frontend

Línea de trabajo

Empieza en src/components/docs/doc-markdown.tsx:216, luego src/lib/docs.ts:290 y la aserción en src/lib/docs.test.ts:210; actualmente cada comentario da el repositorio privado como motivo para renderizar rutas y referencias a issues como texto sin formato. Lee primero los tres sitios en conjunto y resuelve la decisión caso por caso que pide el issue; después actualiza el código, los comentarios y los motivos de las pruebas de forma coordinada. Ejecuta src/lib/docs.test.ts y, si cambia la salida renderizada, actualiza e2e/docs.spec.ts con Playwright. Terminado significa que ningún comentario ni prueba cita la privacidad, y que cada referencia a un archivo o enlaza a GitHub o indica un motivo vigente.

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

Descripción

area: docs documentation priority: P3 size: S

Context

The repository went public on 2026-11-15. Three places still rely on it being private, found in the #457 review:

  • src/components/docs/doc-markdown.tsx:216: "The repository is private, so a path is shown, never linked."
  • src/lib/docs.ts:290: a repository file "renders as text, not a link".
  • src/lib/docs.test.ts:210: "publishes no issue references" gives the private repository as its reason.

Plan

  1. Decide per case whether /docs should now link repository files and issues on GitHub, or keep rendering them as text for another reason.
  2. Update the code, the comments, and the tests to match.

Acceptance criteria

  • No comment or test reason says the repository is private.
  • Repository file references in /docs either link to the file on GitHub or say why they do not.
  • Playwright e2e: e2e/docs.spec.ts updated if links change.

Files and areas

src/components/docs/doc-markdown.tsx, src/lib/docs.ts, src/lib/docs.test.ts. Non-goals: the docs content itself.

Model: anthropic/claude-opus-5-5 | Reasoning effort: unknown

Lenguaje dominante
TypeScript
Estrellas
1
Forks
1
Merge medio
6 h 56 min
PR fusionados (30 d)
136

Preparar el entorno

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 eddiejaoude/StackDash

Todos los issues de eddiejaoude/StackDash

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.