Skip to content

Keep contributor docs to the human workflow - #754

Merged
SaladDay merged 2 commits into
mainfrom
keep-contributor-docs-to-the-human-workflow
Oct 18, 2026
Merged

SaladDay merged 2 commits into
mainfrom
keep-contributor-docs-to-the-human-workflow

Conversation

@SaladDay

@SaladDay SaladDay commented Oct 18, 2026 •

Copy link
Copy Markdown
Collaborator

What

  • CONTRIBUTING.md: moved the agent-process sentences (reviewer instructions, codex exec, "latest explicit user decision") to AGENTS.md "Working in this repository"; the human review contract stays in Review. Cut the Product and execution service separation restatement to the Parsar ownership bullets plus a link to AGENTS.md#public-api. (dev-contracts F8)
  • CONTRIBUTING#documentation-ownership trimmed from 34 rows to the owners a contributor could not guess from a title (component READMEs, IMPLEMENTATION.md, catalog, generated files, installer, Web design docs), with a pointer to docs.json for the rest. Anchor kept. (IA F9, approved)
  • docs/development.md (EN, zh): Documentation row is now make check-docs, make check-names, pnpm --dir website check-translations; the branch example is a kebab-case name; "Claude SDK" is "Claude Code adapter". docs/maintainers.md: make check-docs (not check-distribution) validates tracked Markdown links; CI path-to-group paragraphs became a table and the release path got a flowchart. (F9, F13)
  • apps/web/README.md "README screenshots": two sentences on the fixture demo scene instead of the manual steps; the capture script is not in the repo.
  • Link-text sweep so text equals the target title: Harness protocol, Sandbox Provider protocol, OpenAI compatibility, Workspace filesystem protocol (architecture paragraph 2), Executor credentials (e2b README, machine-api), Session diagnostics (core-errors), API namespaces and credentials, Configuration reference, Add and manage nodes, Overview, Build and release OpenAgentCore, with zh counterparts.
  • zh: 安装器 is 安装程序 in the Markdown outside lane E's files. source_hash refreshed.

Audit claims found wrong

  • maintainers.md already carried the title "Build and release OpenAgentCore".
  • F9: make check-distribution was said to validate links; make check-docs does (BundledDocsTests, tracked Markdown outside example/).

Checks

Run: make check-docs, python3 scripts/check-names.py, node --test website/tests/translations.test.mjs (3 pass).
Skipped: website build and the full gate.

Left out

  • Descriptive inline link phrases ("list rules", "workspace filesystem") are kept; only stale title references changed.
  • Lane E's files (index, quickstart, self-hosted, concepts, api, examples, web) and the "Self-hosted executors" and "OpenAgentCore Web" titles.
  • 安装器 in apps/web/src/i18n/locales/zh-CN/sessions.ts (Web copy, not docs).

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

@SaladDay
SaladDay merged commit ee09cea into main Oct 18, 2026
14 checks passed
@SaladDay
SaladDay deleted the keep-contributor-docs-to-the-human-workflow branch October 18, 2026 05:05
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