From b8d0c10bf8620c2f0d7e4cbbf5678b0b02fbb59f Mon Sep 17 00:00:00 2001 From: ian Date: Wed, 10 Jan 2024 12:58:01 +0800 Subject: [PATCH 1/2] Add a section about docs in README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 2cc655b..5f7329b 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ make all-via-docker cargo test --all ``` +## Docs + +The codebase is well-documented, with detailed comments throughout the source files. Additionally, there are HTML files generated from the code comments in the [docs/] directory, you can clone the repo and open them locally or use a service like [htmlpreview](https://htmlpreview.github.io/). + ## Release Tag and publish the release. GitHub Actions will publish the crate. From b24531e7b004aa1e4e337ee5ad5b3c13f17770ff Mon Sep 17 00:00:00 2001 From: ian Date: Wed, 10 Jan 2024 12:58:48 +0800 Subject: [PATCH 2/2] Fix docs/ relative link in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f7329b..fa3d2b9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ cargo test --all ## Docs -The codebase is well-documented, with detailed comments throughout the source files. Additionally, there are HTML files generated from the code comments in the [docs/] directory, you can clone the repo and open them locally or use a service like [htmlpreview](https://htmlpreview.github.io/). +The codebase is well-documented, with detailed comments throughout the source files. Additionally, there are HTML files generated from the code comments in the [docs/](docs/) directory, you can clone the repo and open them locally or use a service like [htmlpreview](https://htmlpreview.github.io/). ## Release