docs(editorial-style-guide): Fix redundancy, markdown escapes, and add Builder Quick Reference cheat sheet
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- markdown
- Domain
- documentation
Research direction
Find the editorial style guide mentioned in the issue and read its introduction, Critical Style Conventions, and Punctuation sections. Check the repeated instruction and escaped asterisks, then compare the proposed quick reference table with the surrounding guide. Done when the duplication and formatting are corrected and the table is added in the requested location.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- No language data
- Stars
- 1.5k
- Forks
- 534
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from base/brand-kit
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Add a quick-start section for engineers (formats, preferred files, and usage tips)Possibly taken @faisalnugroho claimed this 135 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
шефOpen
Difficulty 1/5 Under an hour Newbie friendliness 15/100
-
началоOpen
Difficulty 5/5 Over a week Newbie friendliness 10/100
Similar issues
-
type: feature
Difficulty 1/5 Under an hour Newbie friendliness 77/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 87/100
adri0/scadustats#128 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
WordPress/hosting-handbook#506 ·
Maintainers usually reply within 2 days
-
community documentation first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 70/100
lingdojo/kana-dojo#32276 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day
-
docs
Difficulty 1/5 Under an hour Newbie friendliness 88/100
adidshaft/grok-gadgets#224 ·
Maintainers usually reply within 1 day