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

Enhance Clarity and Structure of Editorial Style Guide

Aperta
  • Qualcosa non va?
#25 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
content, documentation

Direzione di ricerca

Inizia individuando il Base Editorial Style Guide nel repository e rivedendone i titoli, la terminologia, gli esempi e il tono attuali. Il lavoro è completato quando la guida include un indice navigabile, un glossario per termini come “onchain”, “L2” ed “ETH”, un linguaggio più chiaro in forma attiva ed esempi a supporto delle linee guida elencate.

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

Descrizione

base creative review

Summary:
I propose several enhancements to the Base Editorial Style Guide to improve its clarity, structure, and overall usefulness. These changes aim to make the document more navigable and easier to follow for all contributors.

Proposed Changes:

  1. Add a Table of Contents:

    • To improve navigation and readability, especially for longer documents.
    • Example: 
      ## Table of Contents
1. [Introduction](#introduction)
2. [Why use the style guide?](#why-use-the-style-guide)
3. [About Base](#about-base)
4. [Critical Style Conventions](#critical-style-conventions)
5. [Writing Guidelines](#writing-guidelines)
6. [Nuances](#nuances)

  2. Clarify Technical Terms:

    • Include a glossary for commonly used technical terms to aid understanding.
    • Example: Define terms like "onchain", "L2", and "ETH" in a glossary section.

  3. Expand on "Why use the style guide?":

    • Provide examples of how consistent messaging benefits the brand and community.
    • Example: Explain how consistency can improve brand recognition and trust.

  4. Simplify Language and Ensure Active Voice:

    • Where possible, simplify complex sentences to improve readability.
    • Ensure guidelines about active voice are reflected consistently throughout the document.
    • Example: 
      **Original:** “Experiences that are sticky, that make it easy for anyone to get started, and that offer a seamless user experience that abstracts onchain complexity as much as possible are what we’re looking for.” (passive)
**Edited:** “We’re looking for experiences that make it easy for anyone to get started and offer a seamless user experience that abstracts complexity as much as possible.” (active)

  5. Provide More Examples:

    • Add examples for each guideline to illustrate correct usage.
    • Example: Provide sample sentences demonstrating the preferred use of technical terms, punctuation, and tone.

Benefits of Proposed Changes:

  • Improved navigation and readability for users.
  • Enhanced understanding of technical terms.
  • Clearer and more consistent guidelines.
  • Better examples to guide contributors.

I welcome any feedback or suggestions for further improvements to these proposed changes.

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 Content

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.