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

Jump to bottom

Update the developer documentation. #2067

Merged
merged 1 commit into from
Jun 6, 2023
Merged

Update the developer documentation. #2067

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/contributing-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ bsp/cli connection to it.
## Set the repository up

1. Clone the [GitHub repository](https://github.com/scalacenter/bloop)
1. Change directory to bloop's base directory and run `git submodule update --init`.
1. Change directory to bloop's base directory and run `git submodule update --init`
1. Run the sbt shell in the base directory.

If the sbt shell did not fail, you already have a working bloop build in your
Expand Down Expand Up @@ -195,6 +195,11 @@ Note the bloop version number in the first line of the above logs.

## Updating documentation

### Prerequisites
1. `yarn` is installed - Instructions [here](https://classic.yarnpkg.com/lang/en/docs/install/)
2. `docusaurus` is installed in `yarn` - run `yarn add docusaurus`

### Running
The workflow to update the documentation is the following:

1. Run the docs generation via `bloop run docs -w` or `~docs/run` if you're using the sbt shell.
Expand Down