FarmTrace documentation instructions
Scope
This repository powers the public FarmTrace documentation site on Mintlify. Write for FarmTrace customers, field teams, and integration partners.
Content boundary
Keep this repository safe to publish. Public pages may describe stable Dsync and Device Kit concepts, the generic table setup contract, and the public formula language. Do not add credentials, private endpoints, tenant-specific table schemas, account-specific role policy, internal runbooks, unreleased capabilities, or implementation details that are not part of the supported public contract.
Account-specific configuration belongs in the appropriate private support or operations channel. If a page needs that material to be useful, describe the boundary and direct the reader to their FarmTrace administrator.
Style
- Use active voice and second person where it is natural.
- Keep sentences concise and use sentence case for headings.
- Explain the user-visible outcome before configuration detail.
- Use bold for UI labels and backticks for file names, commands, paths, and code.
- Prefer a short workflow, table, or checklist over a long abstract explanation.
- State prerequisites and limitations next to the behavior they affect.
Mintlify conventions
- Pages are MDX files with YAML frontmatter.
- Site-wide settings and navigation live in
docs.json.
- Keep navigation entries aligned with real page paths.
- Reuse the FarmTrace logo and color tokens already in this repository.
Verification
Before publishing a change:
- Validate
docs.json as JSON.
- Check every navigation page exists.
- Check internal links point to pages in this repository.
- Run the Mintlify preview or build command when available.
- Review the rendered page for clear hierarchy, mobile readability, and public-safe content.
Last modified on September 7, 2026
