Skip to content

docs(agents): refocus contributor guide#97

Merged
onutc merged 2 commits intoopenclaw:mainfrom
onutc:docs-rework-agents-guide
Mar 10, 2026
Merged

docs(agents): refocus contributor guide#97
onutc merged 2 commits intoopenclaw:mainfrom
onutc:docs-rework-agents-guide

Conversation

@onutc
Copy link
Copy Markdown
Contributor

@onutc onutc commented Mar 10, 2026

TL;DR

"agents md shouldn't contain so much technical docs. it should contain info about how to deveop, build, install, test, ci/cd, when to run tests, github repo, etc."
"contain important parts from the vision doc verbatim inside agents md, like scrutinizing, overall vision, it should be thin and such"

Summary

  • Rewrite AGENTS.md around contributor workflow: setup, local development, build, install, testing, CI, release, and key repo references.
  • Keep the important product-direction constraints in the file verbatim from VISION.md.
  • Link readers to the actual in-repo technical references instead of keeping AGENTS.md as a long technical spec.

Review focus

  • Confirm the new AGENTS.md strikes the right balance between contributor workflow and product-direction guardrails.
  • Confirm the linked technical references are the right ones to send contributors to for implementation details.

Test plan

  • pnpm exec oxfmt --check AGENTS.md
  • pnpm exec markdownlint-cli2 AGENTS.md
  • git commit hook completed a local build successfully
  • Full pnpm run check not run locally

@onutc onutc merged commit 6d291e8 into openclaw:main Mar 10, 2026
7 checks passed
@onutc onutc deleted the docs-rework-agents-guide branch March 10, 2026 06:12
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.

1 participant