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

Removed GitBook, add howto contribute docs. #1273

Merged
merged 1 commit into from
Feb 25, 2020
Merged

Removed GitBook, add howto contribute docs. #1273

merged 1 commit into from
Feb 25, 2020

Conversation

mvandermade
Copy link
Contributor

Also added the online submission step-by-step via github.com.

📑 Summary

Brief description about the content of your PR.

Removed the GitBook mention.

Added steps on how to update the documentation.
I included two ways on how to edit and submit the files.

Resolves #1093

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.

I included the online editor functionality because I like to use it myself and requires no tooling on your own local computer.
However the Markdown editors on your local computer might be more powerful to use, so I included that option too.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added unit/e2e tests (if appropriate)
  • 🔖 targeted develop branch

Also added the online submission step-by-step via github.com.
Copy link
Collaborator

@knsv knsv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your clarifications!

@knsv knsv merged commit 73e3137 into mermaid-js:develop Feb 25, 2020
@mvandermade mvandermade deleted the patch-1 branch February 26, 2020 20:27
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

Successfully merging this pull request may close these issues.

Docs wrong about updating the docs
2 participants