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.

Sign up for GitHub

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

Update readme to include preview instructions #1334

Merged
merged 5 commits into from
May 10, 2024
Merged

Update readme to include preview instructions #1334

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ae09d3a
Update README.md
arnaucasau May 9, 2024
78e934c
Update README.md
arnaucasau May 9, 2024
f604761
Update README.md
arnaucasau May 9, 2024
73523cd
Add the `-a` parameter to the readme
arnaucasau May 10, 2024
c4b1901
feedback
arnaucasau May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ The preview application does not include the top nav bar. Instead, navigate to t

Warning: `./start` does not check if there is a new version of the docs application available. Run `docker pull qiskit/documentation` to update to the latest version of the app.

### API docs authors: How to preview your changes

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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

3. Execute `./start` as explained in the previous section.
4. Go to http://localhost:3000 in your browser.

## Preview the docs in PRs

Contributors with write access to this repository can use live previews of the docs: GitHub will deploy a website using your changes.
Expand Down
Loading