Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add troubleshooting guide in a flowchart format #87

Closed
sabbyanandan opened this issue Apr 18, 2022 · 1 comment
Closed

Add troubleshooting guide in a flowchart format #87

sabbyanandan opened this issue Apr 18, 2022 · 1 comment

Comments

@sabbyanandan
Copy link
Contributor

Flowcharts are a better approach to unpack complex scenarios, especially with conditions. That conditionality is always the case when it comes to troubleshooting and debugging.

Mermaid is a tool that is commonly adopted to describe the guide in a markdown format, and it then translates it to visual charts. Mermaid recently also made it into GitHub proper! However, the Docusaurus support is prioritized and still pending.

As a continuation of #86, anything that pertains to troubleshooting can choose this format to explain the steps more visually to readers (i.e., developers).

Here's an example that uses Mermaid to describe the troubleshooting procedure.

@sabbyanandan
Copy link
Contributor Author

cc: @rafaelcr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant