Skip to content

docs: require Node README capability summaries - #2

Merged
mrgh97 merged 2 commits into
masterfrom
codex/node-readme-contract
Oct 22, 2026
Merged

mrgh97 merged 2 commits into
masterfrom
codex/node-readme-contract

Conversation

@mrgh97

@mrgh97 mrgh97 commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Downstream Node repositories need an explicit contract for documenting entrypoints and Tool capabilities. Add the required README fields and template to the contribution guide, link it from the root README, and align the Tool handler description with its Query/Action/Session implementation.

Count production Nodes, Endpoints, operations, HTTP routes and deployment Tool bindings separately. This change only updates documentation.

Maintain independent English README.md and Simplified Chinese README_zh.md, with reciprocal language links and matching API identifiers, commands and configuration examples. Future interface changes must update both documents.

@mrgh97
mrgh97 marked this pull request as ready for review October 22, 2026 12:17
@mrgh97
mrgh97 merged commit 25fe76f into master Oct 22, 2026
3 checks passed
@mrgh97
mrgh97 deleted the codex/node-readme-contract branch November 10, 2026 03:28
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