Improve grammar and terminology consistency in "Building on Scroll" documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Open src/content/docs/en/developers/building-on-scroll.mdx and review the existing wording for terminology, punctuation, and readability. Standardize “zero knowledge” terminology and the “ZK Rollups” versus “zero-knowledge rollups” usage without changing the technical meaning. Done means the page reads consistently and clearly throughout.
Written by the indexing model from the issue text.
Description
What would you like us to improve?
Summary
I reviewed the "Building on Scroll" documentation page and identified minor grammar issues and terminology inconsistencies.
Details
The following improvements were identified:
- Inconsistent usage of “zero knowledge” vs “zero-knowledge”
- Mixed terminology usage (e.g., “ZK Rollups” vs “zero-knowledge rollups”)
- Minor punctuation and clarity refinements
- Small readability improvements without changing technical meaning
File affected:
src/content/docs/en/developers/building-on-scroll.mdx
How important it is?
These changes improve documentation clarity, terminology consistency, and overall professionalism on the live production site (docs.scroll.io).
Clear and consistent documentation directly impacts developer onboarding and trust, especially for infrastructure projects like Scroll.
- Dominant language
- MDX
- Stars
- 701
- Forks
- 196
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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 scroll-tech/scroll-documentation
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
enhancement
scroll-tech/scroll-documentation#427 · 1 comment · 1 assignee ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 35/100
scroll-tech/scroll-documentation#407 · 1 comment · 1 reaction ·
All issues in scroll-tech/scroll-documentation
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·