-
Notifications
You must be signed in to change notification settings - Fork 0
feat(internal-infra): mdx and markdown formatter setup #540
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.
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
Conversation
c9f46a5
to
868321e
Compare
Thanks for the updates across the docs, especially in TON Connect, analytics, TMA Mate hosting, and TVM instructions. A few precise edits are needed to fix a link and tighten style/clarity. Findings (5)Medium (4)Click to expand[MEDIUM] Escaped reference link renders as plain text (broken link)Location:
Description: Suggestion: -For this option, you can deploy the \[official TON Connect Bridge implementation]\[bridge].
+For this option, you can deploy the [official TON Connect Bridge implementation][bridge]. Add a reference definition near the end of the file: [bridge]: https://github.com/ton-blockchain/ton-connect/blob/main/bridge.md [MEDIUM] “etc.” used in a procedural list itemLocation:
Description: Suggestion: -3. Configure your infrastructure (load balancers, SSL certificates, etc.)
+3. Configure your infrastructure (for example, load balancers and SSL certificates) [MEDIUM] Unclear phrasing “from the Mate config prior”Location: mintlify-ton-docs/ecosystem/tma/mate/hosting.mdx Lines 263 to 264 in 10cafb3
Description: Suggestion: -# Both of these commands will use the options
-# from the Mate config prior
+# Both commands use options from the Mate config. [MEDIUM] Banned filler words in reference descriptions (“simply”, “just”)Location: mintlify-ton-docs/tvm/instructions.mdx Lines 733 to 739 in 10cafb3
Description: Suggestion: -Otherwise simply discards both values.
+Otherwise discards both values. -or simply ''perform `c`, then `c'`''.
+or ''perform `c`, then `c'`''. -If `i` does not fit into `n` bits, simply returns `D` `0` (''key not found, dictionary unmodified'').
+If `i` does not fit into `n` bits, returns `D` `0` (''key not found, dictionary unmodified''). -Otherwise, just returns the old value `y` without changing the dictionary.
+Otherwise, returns the old value `y` without changing the dictionary. Low (1)Click to expand[LOW] Missing Oxford comma in a three-item listLocation: mintlify-ton-docs/ecosystem/analytics.mdx Lines 36 to 37 in 10cafb3
Description: Suggestion: - sales, transfers and mints.
+ sales, transfers, and mints. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Choice of technology is understandable.
Obviously we can't review that manually :)
Closes #169.
Why not Prettier? Here's a brief explanation from the Docusaurus's docs:
And this is a link by the end of it: https://github.com/orgs/mdx-js/discussions/2067
In short,
remark
with necessary plugins and some tweaks in configuration works better thanprettier
. Andbiome
, the uprising competitor ofprettier
, cannot even format regular Markdown yet, not to say of MDX.That said, we might bring
prettier
for formatting non-mdx files, such as the files in thesnippets/
directory.