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

docs(editorial-style-guide): Fix redundancy, markdown escapes, and add Builder Quick Reference cheat sheet

Aperta Adatta ai principianti
  • Qualcosa non va?
#94 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Trova la guida di stile editoriale menzionata nell’issue e leggi l’introduzione e le sezioni «Critical Style Conventions» e «Punctuation». Controlla l’istruzione ripetuta e gli asterischi con escape, poi confronta la tabella di riferimento rapido proposta con il resto della guida. Il lavoro è completato quando la duplicazione e la formattazione sono corrette e la tabella è aggiunta nella posizione richiesta.

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

Descrizione

Summary & Context

In response to @jesse.base.eth's open bounty (Warpcast Cast), this contribution proposes concrete improvements to to enhance editorial clarity, fix formatting discrepancies, and provide an instant cheat sheet for onchain builders.

1. Fix Redundancy in Critical Style Conventions

Under :

  • Current text:
  • Issue: The exact same instruction is duplicated back-to-back within the same bullet point.
  • Proposed Fix:
2. Fix Broken Markdown Escapes in Punctuation

Under :

  • Current text:
  • Issue: Escaped raw asterisks render literal backslashes rather than highlighting the bold comma.
  • Proposed Fix:
3. Proposed Addition: At-A-Glance Builder Quick Reference Table

Builders often need a quick lookup rather than reading the entire guide. Adding this summary table right after the introduction drastically improves document usefulness:

Term / Concept ✅ Use This ❌ Avoid / Do Not Use
Network Name Base BASE, Base Chain, Base Network,
Industry / Movement onchain, Onchain web3, crypto, on-chain, On-Chain
Ecosystem Standing Ethereum L2, onchain economy alt-L1, sidechain, eth killer
Partnership Order
Value Proposition utility, experience, access, community 100x gains, pump, speculative returns, token price
Typography / Case Title Case for headlines Sentence case or ALL-CAPS
Punctuation Oxford comma (A, B, and C) A, B and C (missing Oxford comma)
4. Proposed PR

I have prepared the corresponding patch and am ready to submit a pull request if the core team would like to merge these refinements directly.

💰 Bounty Settlement (Base EVM):
cc @bountybot

Lingua principale
Nessun dato sulla lingua
Stelle
1.5k
Fork
533
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 base/brand-kit

Tutte le issue di base/brand-kit

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.