Skip to content

Commit

Permalink
Update docs addresses and remove make docs in README
Browse files Browse the repository at this point in the history
  • Loading branch information
gbraad committed Dec 2, 2024
1 parent adfa7fd commit 55675c8
Showing 1 changed file with 2 additions and 14 deletions.
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,11 @@ CRC binaries with an embedded OpenShift disk image can be downloaded from [this
### Using CRC
The documentation for CRC is currently hosted by GitHub Pages.

See the [CRC Getting Started Guide](https://crc-org.github.io/crc/).
See the [Getting Started Guide](https://crc.dev/docs).

### Building the documentation
You can find the source files for the documentation in the [docs](https://github.com/crc-org/crc/blob/main/docs) directory.

To build the formatted documentation, [install podman](https://github.com/containers/libpod/blob/master/install.md) then use the following:

```shell
$ git clone https://github.com/crc-org/crc
$ cd crc
$ make build_docs
```

This will create a `docs/build/master.html` file which you can view in your browser.

### Developing CRC
Developers who want to work on CRC should visit the [Developing CRC](https://github.com/crc-org/crc/blob/main/developing.adoc) document.
Developers who want to work on CRC should visit the [Developing CRC](https://github.com/crc-org/engineering-docs/blob/main/content/Developing.md) document.

## Community
Contributions, questions, and comments are all welcomed and encouraged!
Expand Down

0 comments on commit 55675c8

Please sign in to comment.