marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-16 05:49:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Support MERMAID_RELEASE_VERSION in docs

Browse Source
This commit is contained in:
Sidharth Vinod
2023-07-07 11:28:04 +05:30
parent 194ef202ac
commit 88856a721f
6 changed files with 59 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/mermaid/src/docs/community/development.md
View File

@@ -212,6 +212,9 @@ If the users have no way to know that things have changed, then you haven't real
Likewise, if users don't know that there is a new feature that you've implemented, it will forever remain unknown and unused.
The documentation has to be updated to users know that things have changed and added!
If you are adding a new feature, add `(v<MERMAID_RELEASE_VERSION>+)` in the title or description. It will be replaced automatically with the current version number when the release happens.
eg: `# Feature Name (v<MERMAID_RELEASE_VERSION>+)`
We know it can sometimes be hard to code _and_ write user documentation.