Add an integrated documentation website

Abierto
#2 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
typescript

Línea de trabajo

Comienza revisando la estructura del repositorio y el flujo de trabajo existente del paquete TypeScript para determinar dónde podría encajar un sitio de documentación integrado. Define el enfoque de despliegue, la compatibilidad con Markdown y fragmentos de código, el modelo de extensiones y el alcance de la página de inicio antes de la implementación; se considerará terminado cuando los forks puedan desplegar y personalizar el sitio de documentación para sus paquetes.

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

Descripción

A documentation website baked into the stack so forks can:

  • Deploy it for free
  • Document the open-source package
  • Have a way to support md and code snippets so they can showcase examples
  • Allow easy extension
  • Add cool landing page?
Lenguaje dominante
TypeScript
Estrellas
121
Forks
11
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una 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.

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.