docs: add high-level architecture diagram (Mermaid) - #56
Merged
Elizabeth Maher (EMaher) merged 13 commits intoMay 15, 2026
Merged
Conversation
Closes #26 Agent-Logs-Url: https://github.com/Azure/apiops-cli/sessions/15f271f0-72f4-4cb9-9bb7-e2388e18c352 Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add high-level architecture diagram for CLI
docs: add high-level architecture diagram (Mermaid)
May 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds high-level architecture documentation for the apiops CLI, including Mermaid diagrams and supporting assets, and wires it into the repo’s entry points (README/devcontainer).
Changes:
- Add
docs/architecture.mdwith Mermaid diagrams describing workflow and internal component structure. - Add local SVG icon assets under
docs/used by the diagrams. - Link the new architecture doc from
README.md, and add devcontainer support for Mermaid previewing.
Reviewed changes
Copilot reviewed 3 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds an “Architecture” link to the new documentation. |
| docs/architecture.md | New architecture document with Mermaid diagrams and an authentication section. |
| docs/10261-icon-service-Azure-DevOps.svg | Adds Azure DevOps icon asset referenced by diagrams. |
| docs/10042-icon-service-API-Management-Services.svg | Adds APIM icon asset referenced by diagrams. |
| .devcontainer/devcontainer.json | Enables git autofetch and adds a Mermaid Markdown extension for VS Code. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…maid diagrams Agent-Logs-Url: https://github.com/Azure/apiops-cli/sessions/6362b9de-dfe9-46fc-81bb-5cb92a322e8a Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Azure/apiops-cli/sessions/6362b9de-dfe9-46fc-81bb-5cb92a322e8a Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Azure/apiops-cli/sessions/f5501a00-ad6c-4752-8727-eacb5ab8df74 Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com>
Elizabeth Maher (EMaher)
approved these changes
May 12, 2026
Elizabeth Maher (EMaher)
marked this pull request as ready for review
May 12, 2026 11:25
Peter Hauge (petehauge)
approved these changes
May 12, 2026
Elizabeth Maher (EMaher)
self-requested a review
May 14, 2026 18:48
Elizabeth Maher (EMaher)
approved these changes
May 14, 2026
Peter Hauge (petehauge)
approved these changes
May 15, 2026
Peter Hauge (petehauge)
left a comment
Peter Hauge (petehauge)
left a comment
Contributor
There was a problem hiding this comment.
looks great!
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
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/architecture.mdIcon Usage note