From c3738401afa57c72eabc080bf7323d42b38ddd61 Mon Sep 17 00:00:00 2001 From: Lorna Mitchell Date: Fri, 17 Nov 2023 16:07:27 +0000 Subject: [PATCH] docs: Add instructions for running the CLI docs standalone from this repo --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9fb44c681..19daf74489 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,6 +93,16 @@ Don't forget to revert the changes to **package.json** files later. ## Contribute documentation +Additions and updates to our documentation are very welcome. You can find the documentation in the `docs/` folder, and this is published to https://redocly.com/docs/cli/ as part of our main website. + +To preview your changes locally, run this command from the `docs/` folder: + +```bash +https://redocly.com/docs/cli/ +``` + +> Please note that currently the custom markdoc tags used in the main website are not available in the local preview version, and links that point to the wider website do show as errors when using a local platform. The pull request workflows generate a full preview, so rest assured that you are able to check everything is in good shape before we review and merge your changes. + ### Prose linting We are proud of our docs. When you open a pull request, we lint the prose using [Vale](https://vale.sh/). You can also install this tool locally and run it from the root of the project with: