Add interactive CodeCanvas diagram for cli #6210
Open
Conversation
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
|
|
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) ✅ code/snyk check is complete. No issues have been found. (View Details) |
Pull Request Submission Checklist
What does this PR do?Introduces a diagram that explains how Snyk CLI works under the hood Where should the reviewer start?The diagram link below How should this be manually tested?Just go through one of the simulations on the diagram What's the product update that needs to be communicated to CLI users?There is now a diagram that explains how Snyk CLI works under the hood, check it out now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I provided answers to the PR template in the comments
🎨 Interactive Architecture Diagram for cli
This PR adds an interactive CodeCanvas diagram to help developers quickly understand the
clicodebase.What is CodeCanvas?
CodeCanvas transforms your repository into an interactive visual diagram that helps developers:
📎 Try it now!
Preview the live diagram before merging: Open Interactive Diagram →
What this PR adds:
clivisuallySimulation refinement tips
You might find that the simulations created in the diagram are incomplete or too elaborative - hit the "Refine Simulation" button. Read the 1 pager guide to learn how to refine simulations to create accurate diagrams.
Need Help?
💬 Join our Discord community: discord.gg/t3ezMyMPqr
After merging, anyone visiting your repository will be able to explore
cliinteractively through CodeCanvas.code-canvas.com