From 55675c8b60cff48971e5a1c87c08f102c06f7d8c Mon Sep 17 00:00:00 2001 From: Gerard Braad Date: Mon, 2 Dec 2024 06:46:35 +0000 Subject: [PATCH] Update docs addresses and remove make docs in README --- README.md | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9fa5e6e996..eb9475179c 100644 --- a/README.md +++ b/README.md @@ -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!