Skip to main content

​
Contribute to docs

This repository mixes current OpenClaw docs, preserved Trellis workflow docs, and curated learning material. Improve clarity in place. Do not remove legacy material unless the change is explicitly about cleanup or migration.

​
Repository content model

TrackStatusHow to edit it
openclaw/ and zh/openclaw/Current maintained trackKeep the reading path clear and update both languages when both pages already exist
guide/, zh/guide/, guides/, zh/guides/Preserved Trellis legacy docsPreserve routes, keep the historical context, and prefer clarification over deletion
ml/ and archived importsCurated entry pages plus raw preserved materialImprove the entry pages first; only promote raw files after cleanup, frontmatter, and link repair

​
Local workflow

  1. Fork and clone the repository.
git clone https://github.com/YOUR_USERNAME/GeneTind-docs.git
cd GeneTind-docs
  1. Install the Mintlify CLI if you do not already have it.
npm install -g mint
  1. Start the local preview.
mint dev
  1. Validate before opening a PR.
mint broken-links
mint validate

​
What usually changes together

  • Content pages in folders such as openclaw/, zh/openclaw/, guide/, zh/guide/, guides/, and zh/guides/
  • Navigation and labels in docs.json
  • Images and static assets in public/, images/, and logo/
  • Bilingual pairs for user-facing OpenClaw pages when both language tracks already exist

​
Contribution rules

  • Use relative links for pages and assets inside the same section or tutorial sequence.
  • Use root-relative links for jumps across major sections.
  • Never link to .md or .mdx files directly.
  • Add new pages to docs.json or they will stay hidden.
  • Prefer improving existing pages over creating parallel pages.
  • Keep code examples free of secrets, private tokens, and internal endpoints.
  • If you touch a user-facing OpenClaw page and the matching page exists in the other language, update both.
  • If you are editing legacy Trellis content, preserve the route and explain legacy status instead of deleting history.
  • If you are editing archived material, add or improve a maintained MDX entry page before exposing more raw files in navigation.
  1. Frontmatter includes title and description.
  2. New or moved pages are registered in docs.json.
  3. Internal links and assets follow the section-relative or cross-section rule above.
  4. mint broken-links passes.
  5. mint validate passes.
  6. The page still matches the surrounding section and language style.

​
Good contribution targets

  • Broken links or navigation drift
  • Outdated setup instructions
  • Thin landing pages that need clearer entry points
  • Better bilingual parity in openclaw/ and zh/openclaw/
  • Cleaner descriptions and frontmatter for discovery and search

​
Issues and pull requests

Found a problem with the docs? Open an issue: https://github.com/lilinji/GeneTind-docs/issues Include:
  • Which page has the issue
  • What is wrong or confusing
  • A suggested fix if you have one
Open a pull request with a clear summary, a list of affected sections, and any validation notes if you could not run Mintlify locally.