infra: content gap analysis

Aperta
#118 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
content, documentation

Direzione di ricerca

Inizia con le pagine sorgente del portale in .sources/portal/docs/, l’albero docs/ esistente e .docs-plan/migration-plan.md. Mappa le pagine sorgente alle pagine della documentazione, valuta la loro rilevanza e obsolescenza, quindi registra le lacune prioritarie in un report strutturato sotto .docs-plan/ o in un commento a un issue. Il lavoro è completato quando le lacune significative sono documentate e per esse sono stati creati issue individuali.

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

Descrizione

enhancement

Context

After the content migration sprints, a systematic comparison of all upstream sources against written docs is needed to find what's missing or outdated.

Steps

  1. List all portal source pages in .sources/portal/docs/
  2. Map each to its corresponding page in docs/ (use migration-plan.md as a starting point)
  3. For pages that exist in portal but not in docs: evaluate if they belong (some portal content is not relevant for the rewrite)
  4. For pages that exist in docs: spot-check for staleness against .sources/ upstream content
  5. File individual issues for any meaningful gaps discovered
  6. Update .docs-plan/migration-plan.md with gap findings

Output

A structured report in .docs-plan/ (or as a GitHub issue comment) listing gaps and their priority.

Lingua principale
JavaScript
Stelle
4
Fork
5
Merge medio
1g 6h
PR unite (30g)
30

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.

Altre issue di dfinity/developer-docs

Tutte le issue di dfinity/developer-docs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.