Skip to content

Conversation

Gusarich
Copy link
Collaborator

@Gusarich Gusarich commented Sep 22, 2025

closes #282

@reveloper
Copy link
Collaborator

reveloper commented Sep 23, 2025

I'm trying to say that we expect readers to have not only basic programming knowledge from an educational program, but also experience with JavaScript (for the front-end) and Java (for the back-end). One to two years of experience is recommended for proper contract development.

I think our target audience should be specified for writing the most detailed recommendations. I think a good source for the target audience: https://developers.google.com/tech-writing/one/audience?_gl=1*dskyej*_up*MQ..*_ga*MTA0MDk2ODM2My4xNzU4MjU3OTkz*_ga_SM8HXJ53K2*czE3NTgyNTc5OTIkbzEkZzAkdDE3NTgyNTc5OTIkajYwJGwwJGgw

cc @novusnota

@Gusarich Gusarich marked this pull request as ready for review September 26, 2025 06:21
@Gusarich Gusarich merged commit ee7d82c into main Sep 26, 2025
4 checks passed
@Gusarich Gusarich deleted the style-guide-update branch September 26, 2025 06:21
Copy link

Thanks for the updates to the style guide. The changes in contribute/style-guide.mdx look good overall; a couple of medium-severity edits are needed to align with the extended rules.

Findings (2)

Medium (2)

Click to expand

[MEDIUM] Acronym “TON” used before first-definition on page

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/92c597c9b8c6dbafea7ff0296f6ef445dc9d0fd9/contribute/style-guide.mdx?plain=1#L10-L10

Description:
The new bullet introduces “TON-specific concepts” without expanding TON on its first mention within this page. Per the extended style guide, acronyms must be spelled out on first use to avoid ambiguity for readers unfamiliar with the term. See https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L134-L138 as the normative rule.

Suggestion:
Expand the acronym on first mention.

-* Default audience: experienced software developers new to blockchain. Explain TON-specific concepts. Do not re-teach general programming. This keeps pages focused.
+* Default audience: experienced software developers new to blockchain. Explain concepts specific to The Open Network (TON). Do not re-teach general programming. This keeps pages focused.

[MEDIUM] Missing exception for generic skills rule

Location: https://github.com/tact-lang/mintlify-ton-docs/blob/92c597c9b8c6dbafea7ff0296f6ef445dc9d0fd9/contribute/style-guide.mdx?plain=1#L10-L10

Description:
The new bullet prohibits re-teaching general programming without the documented exception for TON-specific nuances. This contradicts the canonical rule and can cause authors to remove brief, necessary context. See https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L47-L49 and https://github.com/tact-lang/mintlify-ton-docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L143-L143 for the established exception.

Suggestion:
Restore the exception to align with the canonical phrasing.

- * Default audience: experienced software developers new to blockchain. Explain TON-specific concepts. Do not re-teach general programming. This keeps pages focused.
+ * Default audience: experienced software developers new to blockchain. Explain TON-specific concepts. Do not re‑teach generic developer skills unless a TON‑specific nuance requires it. This keeps pages focused.

@Gusarich Gusarich mentioned this pull request Oct 14, 2025
18 tasks
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.

Extend styleguide with content structure and audience

2 participants