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

Incorrect command to preview local docs changes in contributing.md #1532

Closed
dianacheung opened this issue Apr 18, 2024 · 3 comments
Closed
Labels
Type: Bug Something isn't working

Comments

@dianacheung
Copy link
Contributor

Describe the bug

In the contributing guide (contributing.md), it currently states:

To preview your changes locally, run this command from the docs/ folder:
https://redocly.com/docs/cli/

The above command is incorrect and will result in an error stating that it is not a valid command.

To Reproduce
Steps to reproduce the behavior:

  1. Navigate to the docs/ folder
  2. Run https://redocly.com/docs/cli/
  3. See error

Expected behavior

The correct command to run is: redocly preview
Running the above command will start a local preview server for the docs/ folder. By default, see the docs preview at http://localhost:4000 or http://127.0.0.1:4000.

Note: Make sure redocly is already installed. Include link to installation instructions https://redocly.com/docs/cli/installation/.

@dianacheung dianacheung added the Type: Bug Something isn't working label Apr 18, 2024
@dianacheung
Copy link
Contributor Author

I can work on this issue.

@dianacheung
Copy link
Contributor Author

Hi @lornajane, PR #1533 awaiting review approval. Thanks.

lornajane pushed a commit that referenced this issue Apr 22, 2024
Co-authored-by: Diana Cheung <18452752+dianacheung@users.noreply.github.com>
@tatomyr
Copy link
Contributor

tatomyr commented Apr 22, 2024

I believe this on is resolved by #1533.

@tatomyr tatomyr closed this as completed Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants