docs: add diagram inventory for all repository diagrams (#413)#424
Open
mesutoezdil wants to merge 2 commits into
Open
docs: add diagram inventory for all repository diagrams (#413)#424mesutoezdil wants to merge 2 commits into
mesutoezdil wants to merge 2 commits into
Conversation
…-HAMi#413) Catalogs every technical diagram across docs/, blog/, i18n/, versioned_docs/, and static/ - format, referenced pages, source file availability, and control/data plane separation status. Also records two issues found during the scan: - broken image reference in docs/contributor/contribute-docs.md (path /img/docs/common/architecture/hami-arch.png does not exist) - protocol diagram inconsistency between EN and ZH docs (EN missing the task-dispatch diagram present in ZH) Adds diagrams-inventory to the developers section in sidebars.js. Closes Project-HAMi#413. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mesutoezdil The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
docs/diagrams-inventory.mdcataloging every technical diagram acrossdocs/,blog/,i18n/,versioned_docs/, andstatic/sidebars.jsunder the developers sectionenandzhlocalesIssues found during scan
Broken image reference:
docs/contributor/contribute-docs.md(line 153) references/img/docs/common/architecture/hami-arch.png. That directory does not exist. The correct path is/img/docs/common/developers/hami-core-design/hami-arch.png. This is a separate fix and not included in this PR to keep scope clean.Protocol diagram inconsistency (EN vs ZH):
EN
docs/developers/protocol.mdreferences onlyprotocol-register.png. ZHi18n/zh/.../developers/protocol.mdreferencesdevice-registration.pngandtask-dispatch.png. The EN doc is missing the task-dispatch diagram. Tracked in the inventory; fix belongs in a separate PR.Mindmap audit (#414)
Audit findings are posted as a comment on issue #414. Summary:
hami-vgpu-mind-map-en.png,hami-vgpu-mind-map-zh.png) exist and are actively referenced across all versioned docsCloses #413
Refs #414