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

[No QA] Update documentation to build the help site locally #21422

Merged
merged 1 commit into from
Jun 26, 2023
Merged

[No QA] Update documentation to build the help site locally #21422

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ ln -sf universal-darwin22 universal-darwin21
## Steps

1. Open the Terminal command line in macOS.
1. In the root folder of the repository, execute `npm run createDocsRoutes` to generate the file which contains the routes for the articles (without this, the site will appear empty).
1. Navigate to the `docs` folder in the command line.
1. Run `bundle exec jekyll serve --livereload`.
- _Note: If you see an error like `Unable to load the EventMachine C Extension...`, try running `gem uninstall eventmachine && bundle install`. If that doesn't work just removing the `--livereload` flag should work._
Expand All @@ -46,7 +47,7 @@ ln -sf universal-darwin22 universal-darwin21
### Android Chrome emulator
To visit the site on the Android emulator, go to `10.0.2.2:4000`.

If you're getting an error page that says "Refused to connect", try running `adb reverse tcp:4000 tcp:4000` with your emulator open.
If you're getting an error page that says "Refused to connect", try running `adb reverse tcp:4000 tcp:4000` with your emulator open.


# How the project is structured
Expand Down