Updated gantt chart docs to show all config options

[murdoa]

📑 Summary

Updated docs to show correct available config options for gantt charts. Values used are default values.

Resolves #5191

📏 Design Decisions

N/A minor docs change.

📋 Tasks

Make sure you

• [x ] 📖 have read the contribution guidelines
• 💻 have added necessary unit/e2e tests.
• [ x] 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
• [ x] 🔖 targeted develop branch

[netlify]

❌ Deploy Preview for mermaid-js failed.

Name	Link
🔨 Latest commit	e52fcd0
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/65a06b3e00f4000008aa77c6

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1c43e8e) 80.12% compared to head (e52fcd0) 79.37%.
Report is 25 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #5192      +/-   ##
===========================================
- Coverage    80.12%   79.37%   -0.76%     
===========================================
  Files          167      167              
  Lines        13873    13873              
  Branches       707      707              
===========================================
- Hits         11116    11011     -105     
- Misses        2603     2709     +106     
+ Partials       154      153       -1     

Flag	Coverage Δ
e2e	85.17% <ø> (-0.96%)	⬇️
unit	43.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 9 files with indirect coverage changes

[nirname]

Cool. I am not sure about its following development, because there is automatically generated description, which is publicly available, but there is no direct links to them and they are hard to find.

https://mermaid.js.org/config/schema-docs/config-defs-gantt-diagram-config.html

Maybe @aloisklink knows more about the subject.
PR itself is ok.

[aloisklink]

These aren't the default values, but IMO, that's fine because they might change in the future :)

I agree, having a direct link to https://mermaid.js.org/config/schema-docs/config-defs-gantt-diagram-config.html would be super nice to make it easier for users to see the full documentation for each option (and their default values), but that's something that can be something done in a future PR!

Thanks for the contribution @murdoa!

[mermaid-bot]

@murdoa, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.