Skip to content

Conversation

@Gusarich
Copy link
Collaborator

  • 1. Avoid generic “Introduction” heading; use task-specific label

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L8

“Introduction” is discouraged; headings should be unique and descriptive. For how‑to pages, prefer specific labels like “Goal” or “Overview.” Replace ## Introduction with ## Goal (or ## Overview).
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.3-uniqueness-and-linkability; https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#9.2-how-to-guides-goal-oriented-procedures


  • 2. Replace bold “Prerequisites” label with a proper heading

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L16

Use structure (headings) instead of bold for section labels. Change **Prerequisites** to a heading ## Prerequisites to match the recommended how‑to structure.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#6.2-quotation-marks-and-emphasis; https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#9.2-how-to-guides-goal-oriented-procedures


  • 3. Heading uses Title Case; enforce sentence case

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L26

Headings must use sentence case. Change ## Step-by-Step Deployment Guide to ## Step-by-step deployment guide.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 4. Heading capitalization: “Merkle Tree” → “Merkle tree”

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L30

Apply sentence case in headings. Change ### 1. Prepare the Merkle Tree to ### 1. Prepare the Merkle tree.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 5. Heading capitalization: “Data Collection” → “Data collection”

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L34

Apply sentence case in headings. Change #### Data Collection to #### Data collection.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 6. Heading capitalization: “Tree Generation Process” → “Tree generation process”

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L40

Apply sentence case in headings. Change #### Tree Generation Process to #### Tree generation process.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 7. Heading capitalization: “Best Practices” → “Best practices”

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L53

Apply sentence case in headings. Change #### Best Practices to #### Best practices.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 8. Heading capitalization: “Jetton Master Contract” → sentence case

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L59

Use sentence case with proper nouns only. Change ### 2. Deploy the Jetton Master Contract to ### 2. Deploy the Jetton master contract.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 9. Multiple headings in Title Case; convert to sentence case

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L63-L151

Convert the following to sentence case:

  • #### Contract Requirements#### Contract requirements
  • #### Storage Extensions#### Storage extensions
  • #### Deployment Checklist#### Deployment checklist
  • ### 3. Set Up Off-Chain Infrastructure### 3. Set up off-chain infrastructure
  • #### Merkle Tree Hosting#### Merkle tree hosting
  • #### Custom Payload API Implementation#### Custom payload API implementation
  • #### Performance Considerations#### Performance considerations
  • ### 4. Configure Metadata### 4. Configure metadata
  • #### Required Metadata Fields#### Required metadata fields
  • #### Key Considerations#### Key considerations
  • ## Development Tools and Utilities## Development tools and utilities
    Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form

  • 10. Duplicate H4 headings; make them unique and linkable

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L159-L208

Avoid repeated headings at the same nesting level to improve TOC/linkability. Rename to be specific:


  • 11. Missing language tags on fenced code blocks

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L42-L107

All fenced blocks must specify a language. Add language tags:


  • 12. Placeholder style in commands must use <ANGLE_CASE> and be defined

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L179-L213

Placeholders in commands must use <ANGLE_CASE> and be defined on first use. Update and define:


  • 13. Acronyms not expanded on first mention (TON, API, CDN)

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L10-L121

Spell out on first use, then use the acronym. Examples:


  • 14. Marketing/subjective phrasing in technical introduction

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L10

Technical sections must avoid marketing language. Replace “represent a revolutionary approach” and “comprehensive walkthrough” with neutral, task‑focused wording (e.g., “are a token distribution method” and “this guide provides a walkthrough”).
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#1-goals-and-principles-reader-first-answer-first


  • 15. Code token not formatted as code in checklist

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L80

Tokens/identifiers must use code formatting. Change merkle\_hash to `merkle_hash` (no escape needed inside code font).
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#6.3-code-styling


  • 16. Internal link should be relative and target a stable page

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L13

Internal links should be relative and point to the specific page. Change [basic concepts](/standard/tokens/jettons/mintless) to [basic concepts](./overview) to link directly to the overview page within the same folder.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#16.3-links-and-anchors


  • 17. Prefer a heading over bold label for “API Endpoints”

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L105

Use structure instead of emphasis for section labels. Replace **API Endpoints:** with a heading #### API endpoints.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#6.2-quotation-marks-and-emphasis; https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#7.1-case-and-form


  • 18. Placeholder style must use <ANGLE_CASE> and be defined on first use

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L107-L212

The endpoint uses "{address}"; placeholders must use angle brackets. Change to "GET /api/v1/proof/

" and add a short definition (e.g., " — target TON account address") immediately after the block. Also define placeholders used in commands on first use: "", "" (after line 178), and "" (after line 212). Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#severity-model-release-blocking; Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#101-general-rules.


  • 19. Convert bold labels to subheadings (prefer structure over emphasis)

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L105-L210

Bold label lines with colons should be headings for navigability and consistency. Minimal fixes:


  • 20. How‑to frontmatter titles must use sentence case

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L2-L3

For How‑to pages, set title: "How to X" and sidebarTitle: "X", where X is sentence case. Change to title: "How to deploy mintless jetton" and sidebarTitle: "Deploy mintless jetton" (unless "Jetton" is a proper noun here, but usage across pages favors lowercase). Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#162-navigation-labels.


  • 21. Field names bolded instead of code font

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1

Tokens/identifiers must not be bolded. Minimal fix in “Key considerations”: use code font for field names: mintless_merkle_dump_uri, custom_payload_api_uri.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#6-2-quotation-marks-and-emphasis


  • 22. Acronym order reversed: “BoC (Bag of Cells)”

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1

On first mention, spell out the term, then the acronym in parentheses. Minimal fix: “Bag of Cells (BoC) file”.
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#5-3-acronyms-and-terms


  • 23. Casing of “bag of cells” expansion

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L93

Use the project’s preferred casing: “bag of cells” with lowercase words; “BoC” is uppercase. Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#b-banned-and-preferred-terms (TON‑specific casing). Minimal fix: BoC (bag of cells) file.


  • 24. Missing safety warning callout for funds/chain operations

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L6

Procedures that deploy contracts and send on‑chain messages can move funds and create irreversible state and require a Warning callout. Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#11-safety-critical-content-blockchain-specific and https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#a-admonition-levels-and-usage. Minimal fix: add an <Aside type="danger" title="Warning — funds at risk"> at the top, modeled on https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/how-to-mint.mdx?plain=1#L7–15, noting scope, rollback limits, and advising testnet first.


  • 25. External link used where internal page exists (metadata standard)

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L130

Prefer internal docs when available. Replace the external TEP link with the internal metadata page. Minimal fix: change link target to /standard/tokens/metadata (TEP link may remain as a secondary reference if necessary).
Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#12-links-and-cross-references


  • 26. Throat‑clearing before the prerequisites list

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L18

“Before starting the deployment process, ensure you have:” is wordy throat‑clearing. Minimal fix: change to “You need:”. Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#5-7-avoid-tautology-pleonasm-throat-clearing-and-circular-references


  • 27. Prefer internal link before external TEP

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L67

When an internal docs page exists, link it first. Minimal fix: add an internal link to the Mintless Jetton overview alongside the TEP reference (e.g., “Ensure compatibility with the Mintless Jetton overview and TEP‑177”). Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#12-2-what-to-link-and-what-not


  • 28. Link text is non‑descriptive (“basic concepts”)

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L13

Link text must be descriptive and meaningful out of context. Minimal fix: change [basic concepts](/standard/tokens/jettons/mintless) to [Mintless Jetton overview](/standard/tokens/jettons/mintless/overview). Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#12-1-link-text


  • 29. Frontmatter title/sidebar casing and term consistency

https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/standard/tokens/jettons/mintless/how-to-deploy.mdx?plain=1#L2

The page title should use sentence case and preserve proper nouns. Use the canonical form “Mintless Jetton” as in the overview. Minimal fix: change title: "How to deploy mintless Jetton" to title: "How to deploy Mintless Jetton" and sidebarTitle: "Deploy mintless Jetton" (line 3) to sidebarTitle: "Deploy Mintless Jetton". Rule: https://github.com/tact-lang/mintlify-ton-docs/blob/53b6c23461988d04871b01bac537f21fbd21f860/contribute/style-guide-extended.mdx?plain=1#16-1-how-to-frontmatter-pattern

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.

3 participants