-
Notifications
You must be signed in to change notification settings - Fork 0
feat/fix(internal-infra): formatter updates #552
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
Thanks for the updates across README and the guidebook docs. A few high‑severity link/style issues need fixes before this can merge. Findings (4)High (4)[HIGH] Command uses undefined, non-angle-case placeholdersLocation: Lines 49 to 51 in 529cf9a
Description: Suggestion: -```shell
-npm run fmt:some FILENAME1 FILENAME2
-```
+```shell
+npm run fmt:some <FILE_1> <FILE_2>
+```
+Define placeholders (first use):
+`<FILE_1>`, `<FILE_2>` — paths to files to format. [HIGH] Empty href creates a broken linkLocation: mintlify-ton-docs/guidebook/more.mdx Line 49 in 529cf9a
Description: Suggestion: - <Card
- title="English"
- icon="flag-usa"
- arrow="true"
- href=""
- />
+ {/* Removed temporarily: no English link available */} - <Card
- title="English"
- icon="flag-usa"
- arrow="true"
- href=""
- /> --- a/guidebook/more.mdx
+++ b/guidebook/more.mdx
@@
- <Card
- title="English"
- icon="flag-usa"
- arrow="true"
- href=""
- /> [HIGH] URL shortener used for YouTube linkLocation: mintlify-ton-docs/guidebook/more.mdx Lines 125 to 131 in 529cf9a
Description: Suggestion: - href="https://youtu.be/2wxtiNgXBaU"
+ href="https://[REDACTED]/watch?v=2wxtiNgXBaU" [HIGH] Invalid href in “Hack the TON” cardLocation: mintlify-ton-docs/guidebook/more.mdx Line 203 in 529cf9a
Description: Suggestion: - <Card title="Hack the TON" icon="bug" arrow="true" href="TON Development with Tact">TON-based wargame inspired by The Ethernaut, played in the TON Virtual Machine. Each level is a smart contract that needs to be hacked. Our goal is to help you to learn how to develop safe TON smart contracts and build a thriving community around this craft.</Card>
+ {/* TODO: add valid URL; temporarily removing broken link */} - <Card title="Hack the TON" icon="bug" arrow="true" href="TON Development with Tact">TON-based wargame inspired by The Ethernaut, played in the TON Virtual Machine. Each level is a smart contract that needs to be hacked. Our goal is to help you to learn how to develop safe TON smart contracts and build a thriving community around this craft.</Card>
+ <!-- TODO: Add a valid URL for “Hack the TON” before re-enabling this card. --> --- a/guidebook/more.mdx
+++ b/guidebook/more.mdx
@@
- <Card title="Hack the TON" icon="bug" arrow="true" href="TON Development with Tact">TON-based wargame inspired by The Ethernaut, played in the TON Virtual Machine. Each level is a smart contract that needs to be hacked. Our goal is to help you to learn how to develop safe TON smart contracts and build a thriving community around this craft.</Card> |
8a0f111
to
a239e3b
Compare
/review |
Thanks for the updates here. There’s one small but high‑severity doc style fix needed in README before merge. Findings (1)High (1)[HIGH] Undefined placeholders in command exampleLocation: Lines 49 to 51 in a239e3b
Description: Suggestion: ```shell
-npm run fmt:some <FILE_1> <FILE_2>
+npm run fmt:some <FILES...> +Define placeholders (first use):
+Define placeholders (first use):
+Define placeholders:
|
Install necessary dependencies: npm ci |
To fix the formatting issues:
npx remark -o --quiet --silently-ignore techniques/examples.mdx README.md contribute/snippets/index.mdx ecosystem/ton-connect/walletkit/native-web.mdx guidebook/more.mdx |
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.
formal approval
A follow-up to #540 (MDX and Markdown formatter), and an an update of the
mint
package.