Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
nirname committed Dec 18, 2023
1 parent 2f3f76f commit 3bc3940
Show file tree
Hide file tree
Showing 8 changed files with 3 additions and 242 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Make sure you

- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
- [ ] :computer: have added necessary unit/e2e tests.
- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/docs/community/development.md#3-update-documentation) is used for all new features.
- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/docs/contribution/code.md#update-documentation) is used for all new features.
- [ ] :bookmark: targeted `develop` branch
96 changes: 0 additions & 96 deletions docs/community/development.md

This file was deleted.

109 changes: 0 additions & 109 deletions docs/community/docker-development.md

This file was deleted.

30 changes: 0 additions & 30 deletions docs/config/advanced.md

This file was deleted.

2 changes: 1 addition & 1 deletion packages/mermaid/src/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ function nav() {
{
text: 'Changelog',
link: 'https://github.com/mermaid-js/mermaid/releases',
}
},
],
},
{
Expand Down
3 changes: 0 additions & 3 deletions packages/mermaid/src/docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@

---

# Old Contributing Guide

Please read in detail about how to contribute documentation and code on the [Mermaid documentation site.](https://mermaid-js.github.io/mermaid/#/development)

---

# Mermaid contribution cheat-sheet
Expand Down
2 changes: 1 addition & 1 deletion packages/mermaid/src/docs/community/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ It is located in the [`packages/mermaid/src/docs`](https://github.com/mermaid-js

The contents of [mermaid.js.org](https://mermaid.js.org/) are based on the docs from the `master` branch. Updates committed to the `master` branch are reflected in the [Mermaid Docs](https://mermaid.js.org/) once published.


```mermaid
flowchart LR
classDef default fill:#fff,color:black,stroke:black
Expand All @@ -33,6 +32,7 @@ Start development server for the documentation site
```bash
pnpm --filter mermaid run docs:dev
```

or

```
Expand Down
1 change: 0 additions & 1 deletion packages/mermaid/src/docs/community/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ Detailed information about contributing can be found in the [contribution guide]
- You could work on a new feature! [These](https://github.com/knsv/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Development%22+label%3A%22Help+wanted%21%22+label%3A%22Type%3A+Enhancement%22+label%3A%22Status%3A+Approved%22) are some ideas!
- [Join our slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)


## Last Words

Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there.
Expand Down

0 comments on commit 3bc3940

Please sign in to comment.