Skip to content

feat(sub-second): add how to adopt sub-second finality page#1987

Open
aigerimu wants to merge 15 commits intomainfrom
subsecond-page
Open

feat(sub-second): add how to adopt sub-second finality page#1987
aigerimu wants to merge 15 commits intomainfrom
subsecond-page

Conversation

@aigerimu
Copy link
Contributor

closes #1983

@github-actions

This comment has been minimized.

Copy link
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.

Thanks for the thorough work on ecosystem/subsecond.mdx; I’ve left several suggestions to align wording, formatting, and safety guidance with the docs conventions, so please apply the inline suggestions where they fit. Once updated, the document should read more consistently and be clearer for both UX and infrastructure readers.

@github-actions

This comment has been minimized.

@mintlify
Copy link

mintlify bot commented Mar 20, 2026

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

Project Status Preview Updated (UTC)
mintlify-ton-docs 🟢 Ready View Preview Mar 20, 2026, 9:45 PM

Copy link
Contributor

@it09 it09 left a comment

Choose a reason for hiding this comment

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

Great work, minor comments

Copy link
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.

It's ok to say that, as of now, tangible changes are being made only to the testnet. Yet this page should focus on instructing dApp and wallet devs on how to, well, adopt sub-second finality in their projects. Like, a) what's the status and expected outcome, and b) how to adapt to the changes, with steps or checklists to follow.

All lower-level details, even the name of the consensus protocol (Simplex aka "Catchain 2.0"), should be left to pages within "Blockchain foundations": see #1991 and so on.

@aigerimu @thekiba Let's keep that in mind when rewriting this page, wdyt? :)

@novusnota novusnota marked this pull request as draft March 22, 2026 15:33
@aigerimu aigerimu marked this pull request as ready for review March 23, 2026 09:13
@github-actions
Copy link
Contributor

Thanks for the detailed work on ecosystem/subsecond.mdx: I’ve suggested several edits to tighten task-focused wording, numeric formatting, and references; please apply the inline suggestions. I also flagged one small dictionary tweak in resources/dictionaries/two-letter-words-ban.txt to keep unit usage consistent.


Per-comment submission: 25 posted, 1 failed.

Unposted inline comments (raw text):

  • resources/dictionaries/two-letter-words-ban.txt:L1194-L1200

    [HIGH] Removal of !ms from two-letter banned words weakens unit consistency

    The dictionary change removes the !ms entry from two-letter-words-ban.txt, leaving other case variants like !Ms, !MS, and !mS. This file appears to configure banned two-letter tokens for style or spellchecking, and ms is used throughout the new documentation as a unit abbreviation for milliseconds, not as a standalone word. Allowing ms as an unbanned token increases the risk of inconsistent usage and conflicts with the unit style that treats ms as a numeric unit, not a normal word. Restoring !ms keeps unit formatting consistent and maintains the original enforcement behavior.

    !Mr  …(truncated)
    

Almost each suggestion was improved to be correct and efficient

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions

This comment has been minimized.

@novusnota novusnota marked this pull request as draft March 23, 2026 10:24
@github-actions

This comment has been minimized.

aigerimu and others added 3 commits March 23, 2026 19:54
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@aigerimu aigerimu marked this pull request as ready for review March 23, 2026 13:55
Copy link
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.

Thanks for the thorough work on ecosystem/subsecond.mdx and the sidebar wiring; I’ve left several suggestions to align the doc type, safety callouts, terminology, and media/structure details, so please apply the inline suggestions.

Comment on lines +125 to 127
"ecosystem/subsecond",
"ecosystem/status",
"ecosystem/analytics",
Copy link
Contributor

Choose a reason for hiding this comment

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

[HIGH] Sidebar ordering may misrepresent mixed-content page type

The new ecosystem/subsecond entry is inserted directly before ecosystem/status and ecosystem/analytics within the same ecosystem group. Given that ecosystem/subsecond.mdx mixes explanation, integration guidance, and testing instructions (and currently uses a “How to …” title), its placement in the sidebar risks violating the style guide’s HIGH-severity rule to order docs as Explanation → How‑to → Reference within groups. Without clarifying the page’s type and adjusting its position, navigation may mislead readers about whether the page is a high-level overview, a how-to, or a reference.

Suggested change
"ecosystem/subsecond",
"ecosystem/status",
"ecosystem/analytics",
"ecosystem/status",
"ecosystem/subsecond",
"ecosystem/analytics",

Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!

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.

[Ecosystem > Blockchain nodes] Add a page on the how to move to subsecond finality guide

4 participants