Update doc test
This commit is contained in:
parent
e34e208786
commit
9d5c50a36f
|
@ -22,11 +22,11 @@ This means that **you should branch off your pull request from develop** and dir
|
||||||
|
|
||||||
## Contributing Code
|
## Contributing Code
|
||||||
|
|
||||||
We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein *knsv, Knut Sveidqvist* is the primary reviewer of changes and merging pull requests. The process is as follows:
|
We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows:
|
||||||
|
|
||||||
* Large changes reviewed by knsv or other developer asked to review by knsv
|
- Large changes reviewed by knsv or other developer asked to review by knsv
|
||||||
* Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators
|
- Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators
|
||||||
* Documentation (we encourage updates to the docs folder; you can submit them via direct commits)
|
- Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits)
|
||||||
|
|
||||||
When you commit code, create a branch with the following naming convention:
|
When you commit code, create a branch with the following naming convention:
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ Start with the type, such as **feature** or **bug**, followed by the issue numbe
|
||||||
|
|
||||||
If it is not in the documentation, it's like it never happened. Wouldn't that be sad? With all the effort that was put into the feature?
|
If it is not in the documentation, it's like it never happened. Wouldn't that be sad? With all the effort that was put into the feature?
|
||||||
|
|
||||||
The docs are located in the `docs` folder and are written in Markdown. Just pick the right section and start typing. If you want to propose changes to the structure of the documentation, such as adding a new section or a new file you do that via the **[sidebar](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md)**.
|
The docs are located in the `src/docs` folder and are written in Markdown. Just pick the right section and start typing. If you want to propose changes to the structure of the documentation, such as adding a new section or a new file you do that via the **[sidebar](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md)**.
|
||||||
|
|
||||||
> **All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md)**.
|
> **All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md)**.
|
||||||
|
|
||||||
|
@ -54,7 +54,9 @@ The contents of [https://mermaid-js.github.io/mermaid/](https://mermaid-js.githu
|
||||||
|
|
||||||
We are a little less strict here, it is OK to commit directly in the `develop` branch if you are a collaborator.
|
We are a little less strict here, it is OK to commit directly in the `develop` branch if you are a collaborator.
|
||||||
|
|
||||||
The documentation is located in the `docs` directory and organized according to relevant subfolder.
|
The documentation is located in the `src/docs` directory and organized according to relevant subfolder.
|
||||||
|
|
||||||
|
The `docs` folder will be automatically generated when committing to `src/docs` and should not be edited manually.
|
||||||
|
|
||||||
We encourage contributions to the documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs). We publish documentation using GitHub Pages with [Docsify](https://www.youtube.com/watch?v=TV88lp7egMw&t=3s)
|
We encourage contributions to the documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs). We publish documentation using GitHub Pages with [Docsify](https://www.youtube.com/watch?v=TV88lp7egMw&t=3s)
|
||||||
|
|
||||||
|
@ -70,7 +72,7 @@ To start working with the e2e tests:
|
||||||
|
|
||||||
1. Run `yarn dev` to start the dev server
|
1. Run `yarn dev` to start the dev server
|
||||||
2. Start **Cypress** by running `cypress open` in the **mermaid** folder.
|
2. Start **Cypress** by running `cypress open` in the **mermaid** folder.
|
||||||
(Make sure you have path to Cypress in order, the binary is located in `node_modules/.bin`).
|
(Make sure you have path to Cypress in order, the binary is located in `node_modules/.bin`).
|
||||||
|
|
||||||
The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress.
|
The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue