docs: add mermaid diagrams#46
Merged
Merged
Conversation
Add accurate Mermaid diagrams that GitHub renders natively: - ARCHITECTURE.md: component/dependency diagram (cmd -> controller -> aid/dao/view -> go-tfe -> TFC API, with credentials.yaml and TFC_* env vars feeding token/org resolution) and a sequence diagram for `tecli workspace create`. - README.md: high-level request-flow overview diagram. All mermaid diagrams validated locally with mermaid-cli (3 blocks, 0 failures).
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.
What
Adds Mermaid diagrams to the TECLI documentation. GitHub renders
```mermaidfenced blocks natively, so these appear inline on the rendered pages.Diagrams added
cobra/cmd->cobra/controller->cobra/aid/cobra/dao/cobra/view->hashicorp/go-tfe-> Terraform Cloud/Enterprise API, withcredentials.yaml(underos.UserConfigDir()) andTFC_*environment variables feeding token/organization resolution.tecli workspace createthroughcmd->controller(PreRunE validation, RunE) ->dao(token/org, env-first) ->aid(TFE client, options) ->go-tfe-> the TFC API and back to the printed JSON.go-tfeclient, the TFC API, and the JSON response on stdout.The diagrams reflect the actual code structure (verified against
main.go,cobra/cmd,cobra/controller,cobra/aid,cobra/dao, andgo.mod); no layers were invented.Validation
All mermaid diagrams validated locally with mermaid-cli.
Safety
Compliance files not modified.
No branch protections or settings changed.