TON Docs

Next.js app running Fumadocs documentation framework, with Static Export configured.

All documentation pages are kept in the content/ folder.

Development

Install necessary dependencies:

npm ci

To start a local preview, run the following command at the root of the documentation:

npm start

View the local preview at http://localhost:3000.

Spell checks

Note

Automatic spelling checks are performed for changed files in each Pull Request.

To check spelling of all files, run:

npm run check:spell

# or simply:

npm run spell

To check spelling of some selected files, run:

npm run spell:some <FILES...>

Adding new words to the spellchecking dictionary

The dictionaries (or vocabularies) for custom words are placed under public/dictionaries. There, each dictionary describes additional allowed or invalid entries.

The primary dictionary is public/dictionaries/custom.txt — extend it in case a word exists in American English but was flagged by CSpell as invalid, or in cases where the word does not exist and shall be prohibited. For the latter, add words to public/dictionaries/ban.txt with the ! prefix when there are no clear correct replacements.

If an existing two-letter word was flagged as forbidden, remove it from the public/dictionaries/two-letter-words-ban.txt file. However, if a word happened to be a part of a bigger word, e.g., CL in OpenCL, do not ban it and instead add the bigger word to the primary dictionary in public/dictionaries/custom.txt.

See more: CSpell docs on custom dictionaries.

Format checks

Note

Automatic formatting checks are performed for changed files in each Pull Request.

To check formatting of all files, run:

npm run check:fmt

To fix formatting of all files, run:

npm run fmt

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

npm run fmt:some <FILES...>

Using components and snippets

See the snippets/ directory and the corresponding docs in content/contribute/snippets/ MDX files.

Publishing changes

The GitHub Pages deployment is set up — changes are deployed to production automatically after pushing to the default branch (main).

Need help?

Troubleshooting

• If the dev environment is not running: Run npm ci to ensure you have the most recent version of the CLI.
• If a page loads as a 404: Make sure the page exists under the content/ directory and is not hidden in respective meta.json file on its depth level.

Resources

• Fumadocs documentation
• Fumadocs GitHub
• Next.js documentation
• Interactive Next.js tutorial.

License

This project is dual-licensed:

• All documentation and non-code text are licensed under CC BY-SA 4.0
• All code snippets are licensed under MIT