feat(sub-second): add how to adopt sub-second finality page#1987
feat(sub-second): add how to adopt sub-second finality page#1987
Conversation
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
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.
This comment has been minimized.
This comment has been minimized.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
novusnota
left a comment
There was a problem hiding this comment.
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? :)
|
Thanks for the detailed work on Per-comment submission: 25 posted, 1 failed. Unposted inline comments (raw text):
|
Almost each suggestion was improved to be correct and efficient Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
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>
| "ecosystem/subsecond", | ||
| "ecosystem/status", | ||
| "ecosystem/analytics", |
There was a problem hiding this comment.
[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.
| "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!
closes #1983