Skip to content

refactor(docs): reorganize documentation into tabbed structure#2155

Merged
Alejandbel merged 26 commits into
mainfrom
docs-new-structure-publish
May 14, 2026
Merged

refactor(docs): reorganize documentation into tabbed structure#2155
Alejandbel merged 26 commits into
mainfrom
docs-new-structure-publish

Conversation

@ijonele
Copy link
Copy Markdown

@ijonele ijonele commented May 11, 2026

  • add tabs and new article groups
  • migrate existing content without changing paths
  • rename overview pages for consistency
  • separate Start here and Core concepts
  • updated common.js to check redirects agains the new structure

Closes #2144

Summary by CodeRabbit

  • New Features

    • Added a Smart Contract Development introduction and a Core Concepts guide.
    • Replaced the long getting-started page with a concise "Choose your path" entry.
  • Documentation

    • Reorganized top-level navigation (new Foundations section, Smart contracts top-level link) and reshuffled Applications/Tools content.
    • Updated Wallet/Node pages' sidebar labels and refined browser-extension page formatting.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Warning

Rate limit exceeded

@ijonele has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 52 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fde15707-59e9-4064-ad0f-b62c057c611c

📥 Commits

Reviewing files that changed from the base of the PR and between 79075b2 and 7fdb7de.

📒 Files selected for processing (16)
  • docs.json
  • ecosystem/tma/analytics/analytics.mdx
  • ecosystem/tma/analytics/api-endpoints.mdx
  • ecosystem/tma/analytics/faq.mdx
  • ecosystem/tma/analytics/install-via-npm.mdx
  • ecosystem/tma/analytics/install-via-script.mdx
  • ecosystem/tma/analytics/managing-integration.mdx
  • ecosystem/tma/analytics/preparation.mdx
  • ecosystem/tma/analytics/supported-events.mdx
  • ecosystem/tma/create-mini-app.mdx
  • ecosystem/tma/overview.mdx
  • ecosystem/tma/telegram-ui/getting-started.mdx
  • ecosystem/tma/telegram-ui/overview.mdx
  • ecosystem/tma/telegram-ui/platform-and-palette.mdx
  • ecosystem/tma/telegram-ui/reference/avatar.mdx
  • start-here.mdx
📝 Walkthrough

Walkthrough

Restructures site navigation (adds Foundations), makes nav traversal recursive, adds Core concepts and contract-dev intro pages, shortens the landing page, and updates sidebar labels and list formatting in WalletKit docs.

Changes

Documentation site restructuring and expansion

Layer / File(s) Summary
Navigation traversal implementation
scripts/common.mjs
getNavLinks now recursively processes nested pages/tabs and arrays via processItem(config.navigation) to build navigation links.
Navigation JSON reorganization
docs.json
Reorders and restructures top-level tabs (introduces Foundations), moves/re-groups many pages, and updates multiple redirect mappings.
Foundations — Core concepts content
foundations/core-concepts.mdx
Adds a new Core concepts MDX covering network, accounts, messages, TVM, wallets, standard contracts, cells/BoC, and related tooling/imports.
Contract-dev introduction page
contract-dev/introduction.mdx
Adds a new introductory MDX page linking Acton and Tolk and listing subsequent contract-development topics.
Landing page & sidebar refinements
start-here.mdx, ecosystem/nodes/overview.mdx, ecosystem/walletkit/browser-extension.mdx, ecosystem/walletkit/overview.mdx
Replaces start-here body with a concise entry; standardizes sidebarTitle labels to "Introduction"; and reformats several MDX lists in the WalletKit browser-extension page.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

  • ton-org/docs#2137: Reworks navigation around AI/overview pages and affected nav structure.
  • ton-org/docs#2049: Updates docs.json navigation for TON Center APIs (related APIs grouping changes).
  • ton-org/docs#1527: WalletKit navigation/content edits overlapping with WalletKit MDX changes.

Suggested labels

3p

Suggested reviewers

  • thekiba
  • TrueCarry
  • novusnota
  • kay-is

Poem

🐰 I hopped through docs both wide and deep,
Tabs rearranged while others sleep.
Core concepts planted, a contract's seed,
A tiny guide for every need.
Hop in, explore — there's much to read!

🚥 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 summarizes the main objective: reorganizing documentation into a tabbed structure, which aligns with the primary changes in docs.json and the overall PR objectives.
Linked Issues check ✅ Passed The PR substantially addresses issue #2144 objectives: finalizes the new tabbed structure (docs.json), moves content into new tabs (contract-dev, foundations), adds redirect mappings, and renames pages for consistency.
Out of Scope Changes check ✅ Passed All changes are within scope: contract-dev introduction, foundations reorganization, navigation updates, sidebar title consistency, and script updates to support the new structure align with issue #2144 requirements.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-new-structure-publish

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 11, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify-ton-docs 🟢 Ready View Preview May 11, 2026, 2:23 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@ijonele ijonele changed the title Docs new structure publish A new documentation structure with tabs May 11, 2026
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@ijonele ijonele changed the title A new documentation structure with tabs refactor(docs): reorganize documentation into tabbed structure May 12, 2026
@github-actions

This comment has been minimized.

Alejandbel
Alejandbel previously approved these changes May 14, 2026
@Alejandbel Alejandbel self-requested a review May 14, 2026 08:42
Comment thread ecosystem/walletkit/browser-extension.mdx
@github-actions

This comment has been minimized.

Comment thread ecosystem/tma/analytics/analytics.mdx
@Alejandbel Alejandbel merged commit b3a7fd2 into main May 14, 2026
9 checks passed
@Alejandbel Alejandbel deleted the docs-new-structure-publish branch May 14, 2026 09:23
novusnota added a commit that referenced this pull request May 14, 2026
@Alejandbel Alejandbel restored the docs-new-structure-publish branch May 14, 2026 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Structure] Move docs to a new structure

3 participants