microsoft / microsoft/TypeScript-Website

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

Offen
#3,583 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
2.6k
Forks
1.5k
Ø Merge
2 T. 2 Std.
Gemergte PRs (30 T.)
7

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Durchsicht von issues/2804 und issues/3377 und vergleiche anschließend den verlinkten VitePress-Rebuild mit der aktuellen TypeScript-Dokumentation. Der Vorschlag nennt defekte Links, gemischtes HTML in Markdown und durch Skripte eingefügte Inhalte, benennt jedoch keine Repository-Dateien oder Tests. Für den Abschluss wären eine Einigung des Teams über den Umfang und ein konkreter Migrationsplan erforderlich.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
documentation, web-dev
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.