Skip to content

Commit eddd159

Browse files
committed
docs: update contribution guide with docs-website info.
1 parent eb4382c commit eddd159

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/Guide.Contributing.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,3 +198,25 @@ This is in fact a monorepo that also sports some example projects (for usage ref
198198
- more...
199199

200200
**In order to run E2E tests associated with any of these projects, refer to the [project-specific](https://github.com/wix/Detox/tree/master/examples) READMEs.**
201+
202+
### Detox Documentation Website
203+
204+
The documentation website is built using [Docusaurus](https://docusaurus.io/).
205+
206+
To run the website locally, run the following commands:
207+
208+
```sh
209+
cd website
210+
npm install
211+
npm start
212+
```
213+
214+
To update a specific page, edit the corresponding markdown file in `docs/`. To add a new page, create a new markdown file in `docs/` and add a link to it in `website/sidebars.json`.
215+
216+
While changes to the website are published automatically on every commit to `master` under the `Next` version, tagging and locking docs to a specific version is done automatically on every Detox release.
217+
In case you want to update the docs for a specific version, you can change the related files and code under `website/versioned_docs/version-<version>/` and `website/versioned_sidebars/version-<version>-sidebars.json`.
218+
219+
To update a specific version with the latest changes:
220+
221+
1. Remove the version from `versions.json`.
222+
2. Run `npm run docusaurus docs:version <version>`.

0 commit comments

Comments
 (0)