Edited n00b-GettingStarted.md and smaller edits to README.md and n00b-overview.md #1270
Conversation
This file contains 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
Hi, I love your program and how it reimagines the whole dynamic of creating diagrams and graphs, I also like the wit of the documentation, but I had some small trouble in initially figuring out what the application was about. I propose a few line changes to clarify the purpose of the application and an additional a link to the syntax section of docs to hopefully decrease the friction and increase the interest in using the product. I changed: -"__mermaid is a Javascript based diagramming and charting tool. It generates diagrams flowcharts and more, using markdown-inspired text for ease and speed.__" and I added: -"__The following are some examples of the diagrams, charts and graphs that can be made using mermaid and the Markdown-inspired text specific to it. Click here jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__" More power to you and your team. -Neil
Update README.md
this section had some outdated info regarding the live editor and its capabilities. -replaced and outdated screenshot -edited the documentation to make it a little more n00b friendly. -added a link to the Atom mermaid plugin -Neil
updated documentation for noob-gettingStarted.md. -added a new screenshot and edited directions for copying markdown code from live editor -made some alterations with the instructions in effort to make it more n00b friendly. -added link to Atom-mermaid plugin
Updated noob-gettingStarted.md
NeilCuzon
changed the title
jgreywolf
approved these changes
Feb 24, 2020
jgreywolf
reviewed
Feb 24, 2020
README.md
Outdated
| See our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Play in our [live editor](https://mermaidjs.github.io/mermaid-live-editor/) or jump straight to the [installation and usage](http://mermaid-js.github.io/mermaid/#/usage). | ||
| __mermaid is a Javascript based diagramming and charting tool. It generates diagrams flowcharts and more, using markdown-inspired text for ease and speed.__ | ||
|
|
||
| For more information and help in gettin started, please view our [documentation](http://mermaid-js.github.io/mermaid/) and start simplifying yours. Play with our [live editor](https://mermaidjs.github.io/mermaid-live-editor/) or jump straight to the [installation and usage](http://mermaid-js.github.io/mermaid/#/usage). |
There was a problem hiding this comment.
noted, will correct it immediately.
NeilCuzon
changed the title
mvandermade
reviewed
Feb 26, 2020
mvandermade
reviewed
Feb 26, 2020
mvandermade
reviewed
Feb 26, 2020
mvandermade
reviewed
Feb 26, 2020
erelling
approved these changes
Feb 26, 2020
erelling
approved these changes
Feb 26, 2020
erelling
approved these changes
Feb 26, 2020
mvandermade
reviewed
Feb 26, 2020
erelling
approved these changes
Feb 26, 2020
erelling
approved these changes
Feb 26, 2020
|
thank you for the reviews, I'll correct them immediately. |
|
thanks for the reviews and the edits! this is my first time contributing to Github and I'm thankful for the guidance. |
|
😃First timers you and me both! |
|
Good to hear! Have fun :) |
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.
Hi, I love your program and how it creates diagrams and graphs using text. but I had some small trouble in initially understanding the product's use..
I updated and expanded documentation for noob-gettingStarted.md.
-made some alterations with the instructions in effort to make it more n00b friendly.
-added a new screenshot and edited directions for copying markdown code from live editor
-edited instructions for deploying mermaid with html.
-added link to Atom-mermaid plugin
I also made a few changes in README.md, for the same objective of making it more noob-friendly.
More Power.
-Neil