Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (42 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 2.14 KB
Raw

Contributing to the Agentflow docs

Thanks for helping. This file covers the documentation site only. For the core framework, the CLI, or the client SDK, see the CONTRIBUTING.md in those repositories.

Scope of this repository

The Docusaurus site published at https://agentflow.10xscale.ai. Prose lives in docs/, components in src/components/, generated data in src/data/, maintenance scripts in scripts/.

Corrections to what the framework does usually belong in the framework repo. If the code and the docs disagree, fix the code's docstring first, then reflect it here.

Setup

Node 20 or newer.

npm install
npm start          # dev server with hot reload

The checks

npm run typecheck        # tsc --noEmit
npm run lint:frontmatter # title, description, keywords on every page
npm run lint:links       # external links, network-dependent
npm run build            # catches broken internal links (onBrokenLinks: throw)

npm run build is the one that must pass. Internal links are validated at build time, so a broken cross-reference fails the build rather than shipping.

Making a change

  • Every page in docs/ needs title, description, and keywords in its front matter. npm run lint:frontmatter fails without them. Length warnings are advisory: a short honest description beats a padded one.
  • Follow the Divio split the sidebar already uses: tutorials, how-to guides, reference, concepts. Put the page where a reader would look for it, not where it was easiest to add.
  • Do not hand-edit src/data/contributors.json. It is generated by node scripts/fetch-contributors.mjs.
  • Before a release, run npm run release:prep. It refreshes generated data and runs the checks that only fail at read time.

Commit and pull request expectations

  • One logical change per pull request.
  • Write commit subjects in the imperative mood: fix broken link in the checkpointing guide.
  • Explain why in the pull request body, not just what.
  • CI must be green before review.

License

Agentflow is MIT licensed and made by 10xScale. Contributions are accepted under the same license.