Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[docs] Create documentation for documentation (getting started template, useful tips/tricks)

Aperta
#296 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
38/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Individua la struttura esistente della documentazione per sviluppatori e le pagine comparabili per iniziare, quindi esamina come vengono attualmente utilizzati il frontmatter e componenti come Since, ValidExample e InvalidExample. Il lavoro è completato quando viene aggiunta una guida indipendente dalla versione che copra il modello richiesto, i link e i suggerimenti del frontmatter, i componenti e gli esempi di file.

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

Descrizione

documentation enhancement help wanted
What is the Moodle feature that needs documenting?

For documentation we should document some tips and tricks on getting started, for example:

  • a getting started template
  • useful markdown frontmatter
  • links to the frontmatter docs
  • useful components (Since, ValidExample, InvalidExample)
  • other useful things (including examples from file, etc.)
Is this documentation specific to a Moodle version?

No

Are you able to provide a patch for this?

Yes - I will create one

Lingua principale
TypeScript
Stelle
74
Fork
652
Merge medio
2g 50m
PR unite (30g)
12

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 moodle/devdocs

Tutte le issue di moodle/devdocs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.