Skip to content

Conversation

novusnota
Copy link
Member

@novusnota novusnota commented Oct 1, 2025

Closes #169.

Why not Prettier? Here's a brief explanation from the Docusaurus's docs:

image

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 than prettier. And biome, the uprising competitor of prettier, 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 the snippets/ directory.

@novusnota novusnota changed the title feat(internal-infra): formatter setup feat(internal-infra): mdx and markdown formatter setup Oct 1, 2025
@novusnota novusnota marked this pull request as ready for review October 2, 2025 06:49
Copy link

github-actions bot commented Oct 2, 2025

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:

For this option, you can deploy the \[official TON Connect Bridge implementation]\[bridge].

Description:
This escapes the reference link text so it renders literally, and the [bridge] reference is not defined in the file. Readers see plain text instead of a link.

Suggestion:
Unescape the link and define the reference.

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

Location:

3. Configure your infrastructure (load balancers, SSL certificates, etc.)

Description:
Using “etc.” in a procedure is discouraged because it’s open‑ended and ambiguous. Prefer closed examples or “for example” phrasing.

Suggestion:
Replace with a closed example list.

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

# Both of these commands will use the options
# from the Mate config prior

Description:
“Prior” reads as legalistic and interrupts scanability in the inline comment. Plain, concise wording improves readability.

Suggestion:
Replace with a single, clear sentence.

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

Description: Performs `EXECUTE` for `c` (i.e., _executes_ `c`), but only if integer `f` is non-zero. Otherwise simply discards both values.
Category: cont\_conditional Cont Conditional
#### `DF` IFNOT
Fift: IFNOT
Description: Executes continuation `c`, but only if integer `f` is zero. Otherwise simply discards both values.

Description:
Filler adverbs like “simply/just” reduce precision and are discouraged. Similar instances appear elsewhere in the diff (e.g., 3179, 3572, 3722).

Suggestion:
Remove filler adverbs and keep factual wording.

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

Location:

- [NFT events](https://dune.com/queries?category=canonical\&namespace=ton\&id=ton.nft_events) — comprehensive source of NFT-related data including
sales, transfers and mints.

Description:
The list omits the serial comma in “sales, transfers and mints.” The style guide requires the Oxford comma for clarity.

Suggestion:
Insert the serial comma.

-  sales, transfers and mints.
+  sales, transfers, and mints.

verytactical
verytactical previously approved these changes Oct 2, 2025
Copy link
Collaborator

@verytactical verytactical left a 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 :)

@verytactical verytactical merged commit 32942a8 into main Oct 2, 2025
4 checks passed
@verytactical verytactical deleted the closes-169/formatter branch October 2, 2025 07:51
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.

Setup a formatter and corresponding CI

2 participants