-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
Contribution documentation improvements #5132
Contribution documentation improvements #5132
Conversation
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5132 +/- ##
============================================
+ Coverage 43.04% 80.17% +37.12%
============================================
Files 23 167 +144
Lines 5018 13873 +8855
Branches 21 707 +686
============================================
+ Hits 2160 11122 +8962
+ Misses 2857 2598 -259
- Partials 1 153 +152
Flags with carried forward coverage won't be shown. Click here to find out more. |
In this specific case, I'd prioritize the website user over the GitHub one. Although, the website user seeing the code might not be a major issue. Wonder if this could help. If the markdown parser gives us the full text, that would fix our problem.
|
I think we will leave |
This comment was marked as resolved.
This comment was marked as resolved.
I have fixed the build. |
@sidharthv96 updated branch so build works now |
@aloisklink I remember you were asking to make CONTRIBUTING.md to be exactly the same as our website contributing documentation and combine everything in one page. This PR does exactly what you were looking for |
@nirname Great job Perhaps we can remove the "Contributing" link from the dropdown since there is a link in the Navbar. |
@huynhicode Yep, already removed |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.7.0` -> `10.8.0`](https://renovatebot.com/diffs/npm/mermaid/10.7.0/10.8.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.8.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.8.0) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.7.0...v10.8.0) ### v10.8.0 #### Features <img width="375" alt="image" src="https://github.com/mermaid-js/mermaid/assets/5837277/c17405fb-2a06-4f7c-9c77-5eaba6c76747"> - Adding new diagram type - Block Diagram by [@​knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/5221](https://togithub.com/mermaid-js/mermaid/pull/5221) - Feature/5114 add parallel commit config by [@​mathbraga](https://togithub.com/mathbraga) in [https://github.com/mermaid-js/mermaid/pull/5161](https://togithub.com/mermaid-js/mermaid/pull/5161) - Changes to Gantt Parsers to allow hashes and semicolons to titles, sections, and task data. by [@​FutzMonitor](https://togithub.com/FutzMonitor) in [https://github.com/mermaid-js/mermaid/pull/5095](https://togithub.com/mermaid-js/mermaid/pull/5095) - Feature/4653 add actor-top class to sequence diagram by [@​Ronid1](https://togithub.com/Ronid1) in [https://github.com/mermaid-js/mermaid/pull/5241](https://togithub.com/mermaid-js/mermaid/pull/5241) #### Documentation - Updated gantt chart docs to show all config options by [@​murdoa](https://togithub.com/murdoa) in [https://github.com/mermaid-js/mermaid/pull/5192](https://togithub.com/mermaid-js/mermaid/pull/5192) - Contribution documentation improvements by [@​nirname](https://togithub.com/nirname) in [https://github.com/mermaid-js/mermaid/pull/5132](https://togithub.com/mermaid-js/mermaid/pull/5132) - Update flowchart.md - how to use font-awesome [#​5195](https://togithub.com/mermaid-js/mermaid/issues/5195) by [@​arukiidou](https://togithub.com/arukiidou) in [https://github.com/mermaid-js/mermaid/pull/5196](https://togithub.com/mermaid-js/mermaid/pull/5196) - Add more detailed docs for Gantt tasks by [@​sorenisanerd](https://togithub.com/sorenisanerd) in [https://github.com/mermaid-js/mermaid/pull/5194](https://togithub.com/mermaid-js/mermaid/pull/5194) - Docs/4974 reorder integration links by [@​Ronid1](https://togithub.com/Ronid1) in [https://github.com/mermaid-js/mermaid/pull/5066](https://togithub.com/mermaid-js/mermaid/pull/5066) - docs: fix swimm link by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [https://github.com/mermaid-js/mermaid/pull/5219](https://togithub.com/mermaid-js/mermaid/pull/5219) - Update Slack community links to Discord by [@​Olegt0rr](https://togithub.com/Olegt0rr) in [https://github.com/mermaid-js/mermaid/pull/5225](https://togithub.com/mermaid-js/mermaid/pull/5225) - Docs: Mermaid chart updates by [@​huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/5232](https://togithub.com/mermaid-js/mermaid/pull/5232) - Fix typos in timeline syntax samples by [@​sblom](https://togithub.com/sblom) in [https://github.com/mermaid-js/mermaid/pull/5139](https://togithub.com/mermaid-js/mermaid/pull/5139) #### Bug fixes - Bug/5059 fix external connection after updating edges by [@​mathbraga](https://togithub.com/mathbraga) in [https://github.com/mermaid-js/mermaid/pull/5127](https://togithub.com/mermaid-js/mermaid/pull/5127) - \[Fix] Sequence diagram actor menu popup by [@​vitorsss](https://togithub.com/vitorsss) in [https://github.com/mermaid-js/mermaid/pull/5160](https://togithub.com/mermaid-js/mermaid/pull/5160) - fix: Dompurify Hooks by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5236](https://togithub.com/mermaid-js/mermaid/pull/5236) - Accurate pie chart labeling for text alignment by [@​JenningsWilliam](https://togithub.com/JenningsWilliam) in [https://github.com/mermaid-js/mermaid/pull/5141](https://togithub.com/mermaid-js/mermaid/pull/5141) - fix: Redirect of old URLs by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5250](https://togithub.com/mermaid-js/mermaid/pull/5250) - Fixed Typo in ErrorRenderer.ts by [@​FutzMonitor](https://togithub.com/FutzMonitor) in [https://github.com/mermaid-js/mermaid/pull/5256](https://togithub.com/mermaid-js/mermaid/pull/5256) #### Chores - Revert "Revert 5041 feature/4935 subgraph title margin config option" by [@​mathbraga](https://togithub.com/mathbraga) in [https://github.com/mermaid-js/mermaid/pull/5205](https://togithub.com/mermaid-js/mermaid/pull/5205) - build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/mermaid-js/mermaid/pull/5200](https://togithub.com/mermaid-js/mermaid/pull/5200) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/5150](https://togithub.com/mermaid-js/mermaid/pull/5150) - E2E Image comparison by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5208](https://togithub.com/mermaid-js/mermaid/pull/5208) - E2E test by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5210](https://togithub.com/mermaid-js/mermaid/pull/5210) - Optimise caching of test results by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5213](https://togithub.com/mermaid-js/mermaid/pull/5213) - Update update-browserlist.yml to fix deprecation and action fails by [@​Abrifq](https://togithub.com/Abrifq) in [https://github.com/mermaid-js/mermaid/pull/5151](https://togithub.com/mermaid-js/mermaid/pull/5151) - UpdateCypress by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5228](https://togithub.com/mermaid-js/mermaid/pull/5228) - Use node v20 by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5248](https://togithub.com/mermaid-js/mermaid/pull/5248) - Convert Mindmap to TS by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5247](https://togithub.com/mermaid-js/mermaid/pull/5247) - chore: Add interface naming Convention by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5254](https://togithub.com/mermaid-js/mermaid/pull/5254) #### New Contributors - [@​murdoa](https://togithub.com/murdoa) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5192](https://togithub.com/mermaid-js/mermaid/pull/5192) - [@​arukiidou](https://togithub.com/arukiidou) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5196](https://togithub.com/mermaid-js/mermaid/pull/5196) - [@​sorenisanerd](https://togithub.com/sorenisanerd) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5194](https://togithub.com/mermaid-js/mermaid/pull/5194) - [@​Ronid1](https://togithub.com/Ronid1) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5066](https://togithub.com/mermaid-js/mermaid/pull/5066) - [@​Olegt0rr](https://togithub.com/Olegt0rr) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5225](https://togithub.com/mermaid-js/mermaid/pull/5225) - [@​vitorsss](https://togithub.com/vitorsss) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5160](https://togithub.com/mermaid-js/mermaid/pull/5160) - [@​sblom](https://togithub.com/sblom) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5139](https://togithub.com/mermaid-js/mermaid/pull/5139) - [@​JenningsWilliam](https://togithub.com/JenningsWilliam) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5141](https://togithub.com/mermaid-js/mermaid/pull/5141) **Full Changelog**: mermaid-js/mermaid@v10.7.0...v10.8.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
📑 Summary
Brief description about the content of your PR.
Related #2910
📏 Design Decisions
development.md
,docker-development.md
,code.md
anddocumentation.md
are combined together and refined, and namedcontributing.md
.CONTRIBUTING.md
is now a symlink to our documentation📋 Tasks
Make sure you
MERMAID_RELEASE_VERSION
is used for all new features.develop
branch