Skip to content

feat: improve wording in addresses/overview#1329

Merged
novusnota merged 2 commits into
ton-org:mainfrom
ProgramCrafter:patch-1
Jun 2, 2026
Merged

feat: improve wording in addresses/overview#1329
novusnota merged 2 commits into
ton-org:mainfrom
ProgramCrafter:patch-1

Conversation

@ProgramCrafter
Copy link
Copy Markdown
Contributor

@ProgramCrafter ProgramCrafter commented Nov 19, 2025

Closes #1365

Summary by CodeRabbit

  • Documentation
    • Enhanced clarity in documentation covering TON's account model and address routing mechanisms
    • Refined technical explanations of account identification and related core concepts
    • Improved formatting and structure across documentation files

@github-actions
Copy link
Copy Markdown
Contributor

Skipping AI review because this PR is from a fork. A maintainer can start the review by commenting /review in this PR.

@anton-trunov
Copy link
Copy Markdown
Contributor

/review

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No documentation issues detected.

Comment thread foundations/addresses/overview.mdx Outdated
Comment thread foundations/addresses/overview.mdx Outdated
Comment thread foundations/addresses/overview.mdx Outdated
Comment thread foundations/addresses/overview.mdx Outdated
Comment thread foundations/addresses/overview.mdx Outdated
Comment thread foundations/addresses/overview.mdx Outdated
@verytactical verytactical changed the title Made Actor model description more accessible for beginners feat: improve wording in addresses/overview Nov 20, 2025
@verytactical verytactical added the 3p Reviewed by someone else (a third party). Used for filtering PRs. Don't mind this. label Nov 29, 2025
@novusnota novusnota marked this pull request as draft January 16, 2026 12:21
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3a6c3ca3-0e5d-44a4-a478-00150f7f8978

📥 Commits

Reviewing files that changed from the base of the PR and between 2be7f48 and 2e98b88.

📒 Files selected for processing (2)
  • foundations/addresses/overview.mdx
  • foundations/whitepapers/ton.mdx

📝 Walkthrough

Walkthrough

Documentation-only PR refining language in the Addresses overview to clarify the actor model, define account IDs explicitly as hash(initial_code, initial_data), explain StateInit activation and sharding relationships, and normalizing trailing whitespace in the TON whitepaper.

Changes

Documentation language improvements and formatting

Layer / File(s) Summary
Addresses overview concept refinement
foundations/addresses/overview.mdx
Rephrase actor model introduction with clearer structure, redefine account_id explicitly as hash(initial_code, initial_data), add StateInit activation and fixed_prefix_length details, clarify sharding/Hypercube Routing relationships, and refresh summary bullets with consistent terminology.
Whitepaper whitespace normalization
foundations/whitepapers/ton.mdx
Remove trailing whitespace from section headings and text lines; adjust empty lines around subsection boundaries to normalize spacing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

📚 A rabbit hops through docs with care,
Refining words with thoughtful flair,
Account IDs now crystal clear,
Smart contracts brought much closer near,
Whitespace trimmed, the pages shine—
Language perfect, line by line! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the primary change—improving wording in the addresses/overview documentation with clear, concise phrasing.
Linked Issues check ✅ Passed The PR addresses the linked issue #1365 (Improve language) by rewriting documentation for clarity and accessibility, including rephrasing the Actor model intro, refining Account ID explanations, and updating summary bullets.
Out of Scope Changes check ✅ Passed All changes are scoped to documentation improvements: the addresses/overview.mdx receives substantial wording refinements, and ton.mdx receives minor whitespace normalization—both aligned with improving language clarity.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@novusnota novusnota marked this pull request as ready for review June 2, 2026 17:16
@novusnota novusnota requested a review from a team as a code owner June 2, 2026 17:16
Copy link
Copy Markdown
Collaborator

@novusnota novusnota left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the original PR! I've applied lots of edits in accordance with review comments and my own ideas :)

@novusnota novusnota merged commit a292ad1 into ton-org:main Jun 2, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3p Reviewed by someone else (a third party). Used for filtering PRs. Don't mind this.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve language

5 participants