microsoft / microsoft/TypeScript-Website
【Proposal】Building a Better Next-Generation TypeScript Documentation Experience
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 2.6k
- Fork
- 1.5k
- Merge medio
- 2g 2h
- PR unite (30g)
- 7
Descrizione
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:
-
There are many broken links that still haven't been fixed.
-
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando issues/2804 e issues/3377, quindi confronta la ricostruzione di VitePress collegata con la documentazione TypeScript attuale. La proposta identifica collegamenti non funzionanti, HTML misto in Markdown e contenuti iniettati tramite script, ma non indica alcun file del repository né test. Per considerarlo completato, servirebbero un accordo del team sull’ambito e un piano di migrazione concreto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation, web-dev
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Tranquilla
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100