nodejs / nodejs/doc-kit

Support mermaid diagrams

Aperta
#892 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
65
Fork
71
Merge medio
2g 17h
PR unite (30g)
31

Descrizione

Enter your suggestions in details:

When exploring doc-kit docs within https://github.com/nodejs/doc-kit/pull/889, I was going to render the parsing pipeline as a simple mermaid diagram instead of the codeblock ascii.
I think it would be a reasonable expectation for a generic tool like this, in 2026, to support mermaid diagram rendering.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo il contesto della documentazione di doc-kit e la pull request #889, in cui viene discusso il diagramma della pipeline di parsing. Individua come vengono attualmente renderizzati i blocchi di codice della documentazione e determina l’input Mermaid supportato e il percorso di rendering. Il lavoro è completato quando i diagrammi Mermaid vengono renderizzati correttamente nella documentazione pertinente senza compromettere l’output esistente dei blocchi di codice.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.