Skip to content

Conversation

novusnota
Copy link
Member

@novusnota novusnota commented Oct 2, 2025

A follow-up to #540 (MDX and Markdown formatter), and an an update of the mint package.

@novusnota novusnota requested a review from verytactical October 2, 2025 12:32
@novusnota novusnota marked this pull request as ready for review October 2, 2025 12:32
@novusnota novusnota removed request for a team, thekiba and TrueCarry October 2, 2025 12:33
Copy link

github-actions bot commented Oct 2, 2025

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 placeholders

Location:

```shell
npm run fmt:some FILENAME1 FILENAME2
```

Description:
The command example uses bare placeholders (“FILENAME1 FILENAME2”) without angle brackets or first-use definitions, which increases copy/paste risk and ambiguity. The style guide requires <ANGLE_CASE> placeholders with immediate definitions.

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 link

Location:

(also reported at guidebook/more.mdx?plain=1#L45-L50)

Description:
The “English” course card sets href="", which renders a non-functional link and blocks navigation. Broken anchors are classified as high severity in the style guide.

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 link

Location:

<Columns cols={2}>
<Card
title="Crypto Networks and Why They Matter"
icon="video"
arrow="true"
href="https://youtu.be/2wxtiNgXBaU"
/>

Description:
A video card uses a youtu.be short URL. Shorteners are prohibited; links must be clean and canonical.

Suggestion:

-    href="https://youtu.be/2wxtiNgXBaU"
+    href="https://[REDACTED]/watch?v=2wxtiNgXBaU"

[HIGH] Invalid href in “Hack the TON” card

Location:

<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>

Description:
The card sets href="TON Development with Tact", which is not a valid absolute or repo‑relative URL, resulting in a broken link. Broken anchors are classified as high severity; use a valid HTTPS or repo‑relative target.

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>

@novusnota
Copy link
Member Author

/review

Copy link

github-actions bot commented Oct 2, 2025

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 example

Location:

```shell
npm run fmt:some <FILE_1> <FILE_2>
```

Description:
The example introduces <FILE_1> and <FILE_2> without defining them on first use, which creates copy/paste ambiguity. This violates the style guide requirement to define angle‑case placeholders at first mention (see https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L391-L400, https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L581-L586, and https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L393-L397).

Suggestion:
You can apply one of these fixes:

 ```shell
-npm run fmt:some <FILE_1> <FILE_2>
+npm run fmt:some <FILES...>

+Define placeholders (first use):
+<FILES...> — space-separated file paths to format.


```diff
 To check and fix formatting of some **selected** files, run:

 ```shell
 npm run fmt:some <FILE_1> <FILE_2>

+Define placeholders (first use):
+<FILE_1> — path to the first file to format.
+<FILE_2> — path to the second file to format.


```diff
 To check and fix formatting of some **selected** files, run:

 ```shell
 npm run fmt:some <FILE_1> <FILE_2>

+Define placeholders: <FILE_1>, <FILE_2> — paths to files you want to format.

Copy link

github-actions bot commented Oct 2, 2025

Install necessary dependencies: npm ci
Then, run this to fix formatting: 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

Copy link

github-actions bot commented Oct 2, 2025

To fix the formatting issues:

  1. Install necessary dependencies: npm ci
  2. Then, run this command:
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

@novusnota novusnota changed the title feat(guidebook): more tutorials feat/fix(internal-infra): formatter updates Oct 2, 2025
Copy link
Member

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

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

formal approval

@novusnota novusnota merged commit 0709450 into main Oct 2, 2025
4 checks passed
@novusnota novusnota deleted the closes-94/more-tuts branch October 2, 2025 17:42
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.

2 participants