docs: add TinyGo sync strategy documentation #10
Conversation
Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: luoliwoshang <[email protected]>
|
@xgopilot update the CLAUDE.md to link this [docs/tinygo-sync-strategy.md] |
✅ Task CompleteCreated Changes made:
The CLAUDE.md file now contains a Documentation section that links to the TinyGo sync strategy guide. |
Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: luoliwoshang <[email protected]>
|
@xgopilot tinygo not directly store |
✅ Task CompleteUpdated the TinyGo sync strategy documentation to clarify that Changes made:
|
Updated documentation to specify that src/device and src/machine are copied from TinyGo release packages rather than directly from the repository, as these modules are not stored in TinyGo's repo. Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: luoliwoshang <[email protected]>
docs/tinygo-sync-strategy.md
Outdated
| ### `machine` Branch | ||
| - **Responsibility**: Pure mirror of TinyGo's official `src/machine` module | ||
| - **Update Source**: TinyGo release packages (e.g., [tinygo0.39.0.linux-amd64.tar.gz](https://github.com/tinygo-org/tinygo/releases)) | ||
| - **Note**: TinyGo does not directly store `src/machine` in their repository. Copy this module from official release packages. | ||
| - **Rules**: Sync only, no custom modifications | ||
| - **Commit Tag**: `[SYNC] Update machine to TinyGo <version>` | ||
|
|
||
| ### `device` Branch | ||
| - **Responsibility**: Pure mirror of TinyGo's official `src/device` module | ||
| - **Update Source**: TinyGo release packages (e.g., [tinygo0.39.0.linux-amd64.tar.gz](https://github.com/tinygo-org/tinygo/releases)) | ||
| - **Note**: TinyGo does not directly store `src/device` in their repository. Copy this module from official release packages. | ||
| - **Rules**: Sync only, no custom modifications | ||
| - **Commit Tag**: `[SYNC] Update device to TinyGo <version>` |
There was a problem hiding this comment.
@xgopilot some redundant at machine Branch & device Branch
There was a problem hiding this comment.
✅ Task Complete
Eliminated redundancy by consolidating the machine and device branch sections into a single combined section since they share identical properties (update source, rules, and commit tag structure).
Changes made:
- Merged separate machine and device sections into one "machine and device Branches" section
- Reduced from 14 lines to 9 lines while maintaining all essential information
- Committed and pushed to the PR branch (docs/tinygo-sync-strategy.md:12-19)
There was a problem hiding this comment.
@xgopilot note the src/device and src/machine in each platform of the release package are identical, so one of them was selected.
Combined the machine and device branch sections to eliminate redundancy, as both branches share identical update source, rules, and structure. Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: luoliwoshang <[email protected]>
|
@xgopilot note the src/device and src/machine in each platform of the release package are identical, so one of them was selected to copy |
✅ Task CompleteUpdated the TinyGo sync strategy documentation to clarify that Changes made:
This clarification will help developers understand they don't need to download multiple platform packages when syncing TinyGo modules. |
Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: luoliwoshang <[email protected]>
Requested by @luoliwoshang
Summary
This PR adds documentation for the TinyGo sync strategy to the
docsfolder as requested in issue #9.Changes
docs/directorydocs/tinygo-sync-strategy.mddocumenting:machine,device,main)Closes #9