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

Contribution documentation improvements #5132

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
57f0a3a
Contribution documentation improvements
nirname Dec 11, 2023
01908b1
Development Into planning
nirname Dec 11, 2023
0506ba8
Fixed linters
nirname Dec 17, 2023
f66f4f4
Use deep outline for the whole documentation website
nirname Dec 18, 2023
7b6764d
Merge branch 'develop' into docs/2910_update-contributing-guidelines
nirname Dec 18, 2023
2f3f76f
Contribution guidelines rework
nirname Dec 18, 2023
3bc3940
Formatting
nirname Dec 18, 2023
5b58883
Update docs
nirname Dec 18, 2023
2705c0d
Different fixes
nirname Dec 19, 2023
3782969
Update docs
nirname Dec 19, 2023
d2b9240
Simplify things
nirname Dec 19, 2023
97ee5a8
Update docs
nirname Dec 19, 2023
dfa0ad5
Refined contribution guide again
nirname Dec 21, 2023
d54d13e
Update docs
nirname Dec 21, 2023
807a5bf
Batch of small improvements for the documentation
nirname Jan 4, 2024
8edf96f
Update docs
nirname Jan 4, 2024
a7d0d41
Small reorganizing
nirname Jan 4, 2024
e2fd5ec
Update docs
nirname Jan 4, 2024
e7824f0
Fixes for tutorials link
nirname Jan 4, 2024
a32e72b
Update docs
nirname Jan 4, 2024
98cf63e
Merge branch 'develop' into docs/2910_update-contributing-guidelines
nirname Jan 4, 2024
67dde70
Fixes
nirname Jan 5, 2024
9aaf631
Removed unused files
nirname Jan 5, 2024
9ccb340
Update docs
nirname Jan 5, 2024
3c27f46
Fixed dead links
nirname Jan 5, 2024
a05aba4
Update docs
nirname Jan 5, 2024
17312a0
Cleanup
nirname Jan 5, 2024
e0bd684
Removed duplicated docs, keep community folder name
nirname Jan 5, 2024
6d5f338
Fixed redirects
nirname Jan 5, 2024
5f9b965
Linters
nirname Jan 5, 2024
be7c637
Update docs
nirname Jan 5, 2024
e628f64
Empty
nirname Jan 5, 2024
7219d60
Updated contributing docs after review, minor fixes
nirname Jan 11, 2024
374e788
Update docs
nirname Jan 11, 2024
21ecc28
Merge branch 'develop' into docs/2910_update-contributing-guidelines
nirname Jan 11, 2024
26f6aec
build
nirname Jan 11, 2024
a3092fc
Fixed dead link
nirname Jan 11, 2024
f6b321d
Removed volta requirement, leave pnpm only
nirname Jan 13, 2024
621d6cb
Fix linters
nirname Jan 13, 2024
3290c38
Update docs
nirname Jan 13, 2024
385bf32
Remove npx completely from run script
nirname Jan 13, 2024
bafb991
Run dev docs without npx
nirname Jan 13, 2024
36fdff8
Merge branch 'develop' into docs/2910_update-contributing-guidelines
nirname Jan 15, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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/community/contributing.md#update-documentation) is used for all new features.
- [ ] :bookmark: targeted `develop` branch
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ stats/

demos/dev/**
!/demos/dev/example.html
tsx-0/**
78 changes: 0 additions & 78 deletions CONTRIBUTING.md

This file was deleted.

1 change: 1 addition & 0 deletions CONTRIBUTING.md
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
FROM node:18.19.0-alpine3.18 AS base
RUN wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.shrc" SHELL="$(which sh)" sh -
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,12 @@ Mermaid addresses this problem by enabling users to create easily modifiable dia
<br/>

Mermaid allows even non-programmers to easily create detailed diagrams through the [Mermaid Live Editor](https://mermaid.live/).<br/>
For video tutorials, visit our [Tutorials](./docs/config/Tutorials.md) page.
For video tutorials, visit our [Tutorials](./docs/ecosystem/tutorials.md) page.
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/ecosystem/integrations-community.md).

You can also use Mermaid within [GitHub](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) as well many of your other favorite applications—check out the list of [Integrations and Usages of Mermaid](./docs/ecosystem/integrations-community.md).

For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/intro/getting-started.md), [Usage](./docs/config/usage.md) and [Tutorials](./docs/config/Tutorials.md).
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/intro/getting-started.md), [Usage](./docs/config/usage.md) and [Tutorials](./docs/ecosystem/tutorials.md).

In our release process we rely heavily on visual regression tests using [applitools](https://applitools.com/). Applitools is a great service which has been easy to use and integrate with our tests.

Expand Down
4 changes: 2 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ Mermaid 是一个基于 Javascript 的图表绘制工具,通过解析类 Markd
Mermaid 通过允许用户创建便于修改的图表来解决这一难题,它也可以作为生产脚本(或其他代码)的一部分。<br/>
<br/>
Mermaid 甚至能让非程序员也能通过 [Mermaid Live Editor](https://mermaid.live/) 轻松创建详细的图表。<br/>
你可以访问 [教程](./docs/config/Tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/ecosystem/integrations-community.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
你可以访问 [教程](./docs/ecosystem/tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/ecosystem/integrations-community.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。

如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/intro/getting-started.md), [用法](./docs/config/usage.md) 和 [教程](./docs/config/Tutorials.md).
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/intro/getting-started.md), [用法](./docs/config/usage.md) 和 [教程](./docs/ecosystem/tutorials.md).

<!-- </Main description> -->

Expand Down
9 changes: 6 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
version: '3.9'
services:
mermaid:
image: node:18.19.0-alpine3.18
build:
context: .
dockerfile: Dockerfile
stdin_open: true
tty: true
working_dir: /mermaid
mem_limit: '4G'
mem_limit: '8G'
entrypoint: '/mermaid/docker-entrypoint.sh'
environment:
- NODE_OPTIONS=--max_old_space_size=4096
- NODE_OPTIONS=--max_old_space_size=8192
volumes:
- ./:/mermaid
- root_cache:/root/.cache
Expand Down
3 changes: 3 additions & 0 deletions docker-entrypoint.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/sh
source /root/.shrc
exec "$@"
176 changes: 0 additions & 176 deletions docs/community/code.md

This file was deleted.