Document that the doctest crate might need updating ()

Also rename the "Examples" build to "Doctest" to clarify what it does.
This commit is contained in:
Chris Wong 2022-04-10 20:29:41 +10:00 committed by GitHub
parent e6787cd621
commit d04a2c6a01
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 2 deletions
.github/workflows
CONTRIBUTING.md

View file

@ -61,8 +61,8 @@ jobs:
- name: Check Clippy
run: cd docs && cargo clippy --all-targets -- -D warnings
examples:
name: Examples
doctest:
name: Doctest
runs-on: ubuntu-latest
steps:

View file

@ -6,10 +6,13 @@ Great to see that you want to help out! Here are some tips for getting started:
* Most contributions should include [tests] and a [changelog entry].
* If you're adding or updating a web framework integration, you might need to update the [doctest crate].
* Want to work on documentation? See the [docs readme] for advice on that.
Have fun! ☺️
[tests]: maud/tests
[changelog entry]: CHANGELOG.md
[doctest crate]: doctest/Cargo.toml
[docs readme]: docs/README.md