void-linux / void-linux/void-docs

Use bolding only for warnings?

Offen
#324 11 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
CSS
Sterne
217
Forks
212
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
1

Beschreibung

As discussed at #297 (e.g. this comment by @ericonr), i think it would be good to draw readers' attention to warnings via bolding. However, to ensure a consistent meaning for bolding, i think it should perhaps only be used in such cases, rather than to e.g. introduce terms, as in #177, where emphasis via *term* could be used instead.

(However, i don't think this issue should be considered a blocker for #177.)

Beitragsleitfaden

Beitragsleitfaden öffnen

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 Issue #297, des verlinkten Kommentars von @ericonr und Issue #177, um die vorgeschlagene Bedeutung von Fettdruck und Hervorhebung in der Dokumentation zu verstehen. Ermittle die betroffenen Verwendungen in der Dokumentation, einigen Sie sich auf eine konsistente Richtlinie, die nur Warnungen ausgibt, und aktualisiere die relevanten Markdown-Inhalte, sobald der Umfang festgelegt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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