add comment and code reorg #69
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces several documentation improvements and updates to project rules, focusing on clearer guidelines for code and documentation maintenance, bilingual documentation practices, and technical doc updates for new and existing features. The changes help standardize documentation structure, improve discoverability, and clarify code-to-doc relationships across the repo.
Project rules and documentation standards:
Technical documentation updates:
API and code reference documentation:
ExecutionResponse, with explicit field documentation and code references in both languages. (docs/execution-response-fields-en.md, docs/execution-response-fields-zh.md) [1] [2]ExecutionRequesttoExecutionWorkItemin both English and Chinese docs. (docs/artifact-task-instance-architecture-overview-en.md, docs/artifact-task-instance-architecture-overview-zh.md) [1] [2]InvokeRequestandsubmit_invocationinstead of the previous request/manager pattern, in both English and Chinese. (docs/function-service-integration-en.md, docs/function-service-integration-zh.md) [1] [2]Documentation index and discoverability:
These changes collectively improve documentation quality, project maintainability, and developer onboarding.