Skip to content

feat(styleguide): make target audience more clear #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 26, 2025
Merged

feat(styleguide): make target audience more clear #377

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1e13ee
feat(styleguide): make target audience more clear
Gusarich Sep 22, 2025
92c597c
Merge branch 'main' into style-guide-update
Gusarich Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contribute/style-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ This guide covers the basics: how to structure pages, write examples, and keep d

## Write for the reader

* Default audience: experienced software developers new to blockchain. Explain TON-specific concepts. Do not re-teach general programming. This keeps pages focused.
* Be answer‑first. Start with what the reader will achieve, what they need, and the steps. This shortens time to success.
* Lead with a working example. Show a copy‑pasteable snippet early and the expected output. This shows it works.
* Use a neutral, precise tone. Write in present tense, active voice, and second person (“Run the node”). This makes actions clear.
* Keep it scannable. Use short sections and paragraphs, clear headings, lists, and tables. Most readers skim to find the next action.
* Assume developers are new to blockchain. Don’t re‑teach generic skills unless a TON‑specific nuance requires it. This keeps pages focused.

## Page types

Expand Down