Update readme to include preview instructions #1334
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 |
|
Jake is submitting a patch to simplify this process. So let's wait to merge this until his patch has landed. |
README.md
Outdated
| API docs authors can preview their changes to one of the APIs by using the `-a` parameter to specify the path to the docs folder: | ||
|
|
||
| 1. Run `npm run gen-api -- -p <pkg-name> -v <version> -a <path/to/docs/_build/html>`. | ||
| 2. Open Rancher Desktop (not necessary for Linux). |
There was a problem hiding this comment.
It'd be better to move these instructions to the above section. I'd explain the step in the above section as:
Ensure Docker is running. For example, open Rancher Desktop.
Then, this secton can be:
1. <same as before>
2. Execute `./start` and open up `http://localhost:3000`, as explained in the prior section.
Eric-Arellano
approved these changes
May 10, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
The PR adds instructions to the readme to preview changes made for API docs authors locally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR adds instructions to the readme to preview changes made for API docs authors locally.