【Proposal】Building a Better Next-Generation TypeScript Documentation Experience

Abierto
#3,583 3 comentarios 1 reacción 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
Documentación
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
documentation, web-dev

Línea de trabajo

Empieza revisando issues/2804 y issues/3377; después, compara la reconstrucción de VitePress enlazada con la documentación actual de TypeScript. La propuesta identifica enlaces rotos, HTML mezclado en Markdown y contenido inyectado por scripts, pero no menciona archivos del repositorio ni pruebas. Para darlo por terminado, harían falta un acuerdo del equipo sobre el alcance y un plan de migración concreto.

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

Descripción

I previously shared my suggestions here: issues/2804#issuecomment-3567600241. More than half a year has passed, yet I still haven't seen any official response from the team regarding documentation improvements. I can understand that the main focus may currently be on the arrival of TS 7.x rather than the documentation side of things, so I decided to move forward with this myself.

I rebuilt the documentation using vitepress, and the result is available at: tslang.org. Compared to typescriptlang.org, the overall user experience has improved significantly.

In particular, regarding the TypeScript tsconfig reference page, I also noticed that users have already raised complaints about it in issues#3377.

Current problems with the official documentation:

  1. There are many broken links that still haven't been fixed.

  2. Some markdown files contain a large amount of mixed HTML syntax such as tables, and many HTML tags are not even properly closed.

A large portion of this content is dynamically injected into markdown files through scripts. In practice, documentation should avoid this approach whenever possible. All content should be written directly in the documentation itself, which makes long-term maintenance much easier.

At the moment, the source code for this documentation project is hosted in my private repository. If the TypeScript team believes this documentation aligns with the vision and needs of a next-generation documentation experience, I would be willing to transfer the repository to the official project.

Once the official team agrees to move forward with this direction, issues#2804 can finally proceed to the next stage.

Lenguaje dominante
TypeScript
Estrellas
2.6k
Forks
1.5k
Merge medio
1 d 12 h
PR fusionados (30 d)
5

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 microsoft/TypeScript-Website

Todos los issues de microsoft/TypeScript-Website

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.