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

Enhancement Proposal: Improve Code Block Language Specifiers Across Documentation

Aperta
#6,526 5 commenti 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
58/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
bash, go, markdown, yaml
Ambito
documentation

Direzione di ricerca

Leggi prima la guida per i contributori, poi controlla i file del blog indicati, la directory code-samples/ e gli altri file Markdown in docs/. Verifica ogni blocco di codice delimitato rispetto al linguaggio appropriato e ai nomi coerenti consigliati, come go, bash e yaml. Il lavoro è completato quando le sorgenti della documentazione non contengono specificatori di linguaggio mancanti o incoerenti.

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

Descrizione

triage/accepted

Background & Validation:
Several documentation files in the repository—including blog articles, concept guides, and code samples—contain fenced code blocks that do not specify their language, or use inconsistent language tags (such as missing specifiers for go, bash, yaml, etc.). This issue appears commonly in:

The Knative docs contributor's guide recommends correct language specifiers for code blocks, but enforcement is inconsistent.

Proposed Enhancement
  • Audit all documentation sources (docs/, code-samples/, and relevant blog articles).
  • Update each markdown code block to specify the appropriate language (use “go”, “bash”, “yaml”, etc.).
  • Use consistent names (e.g., always “bash” for shell scripts, “go” for Go code, “yaml” for manifests).
  • Reference: MkDocs Material supported languages.
Benefits
  • Enables syntax highlighting and improves readability for contributors and users.
  • Supports better onboarding—new contributors can more easily read and copy-paste sample code.
  • Aligns with markdown documentation best practices and the Knative docs style guide.
References
Lingua principale
HTML
Stelle
5.1k
Fork
1.3k
Nessuna PR unita negli ultimi 30g

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 knative/docs

Tutte le issue di knative/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.