Skip to content

Add a section about docs in README.md #97

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

Open
doitian wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a section about docs in README.md #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8d0c10
Add a section about docs in README.md
doitian Jan 10, 2024
b24531e
Fix docs/ relative link in README
doitian Jan 10, 2024
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/](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.