Skip to content

Commit

Permalink
fix: correct contribute documentation preview locally (#1532) (#1533)
Browse files Browse the repository at this point in the history
Co-authored-by: Diana Cheung <[email protected]>
  • Loading branch information
dianacheung and dianacheung authored Apr 22, 2024
1 parent cb5328c commit 210f4f1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,18 @@ Don't forget to revert the changes to **package.json** files later.

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:
To preview your documentation changes locally:

1. Make sure `redocly` is already installed on your local computer. See [installation](https://redocly.com/docs/cli/installation/).

2. Run this command from the `docs/` folder:

```bash
https://redocly.com/docs/cli/
redocly preview
```

By default, you can access the docs preview at http://localhost:4000 or http://127.0.0.1:4000.

> 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
Expand Down

1 comment on commit 210f4f1

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 76.84% 4415/5746
🟡 Branches 67.1% 2400/3577
🟡 Functions 70.58% 734/1040
🟡 Lines 77% 4145/5383

Test suite run success

722 tests passing in 101 suites.

Report generated by 🧪jest coverage report action from 210f4f1

Please sign in to comment.