Skip to content

Commit

Permalink
Documentation snapshot/release README.md section (#348)
Browse files Browse the repository at this point in the history
  • Loading branch information
markmandel authored Jul 27, 2021
1 parent 64c25fc commit 8b37493
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,18 @@ Project is currently in *alpha* status, and is being actively developed. Expect

Not to be used in production systems.

## Usage
## Documentation

### Releases

* v0.1.0 ([guides](https://github.com/googleforgames/quilkin/blob/v0.1.0/README.md#usage),
[api](https://docs.rs/quilkin/0.1.0/quilkin/), [macros](https://docs.rs/quilkin-macros/0.1.0/quilkin_macros/)).

### Usage

> Below is documentation for the development version of Quilkin. To view the documentation for a specific release,
> switch to the release tag in the dropdown at the top of the page, or click on the appropriate release documentation
> link above.
* Start with our [Project Overview](./docs/README.md).
* See how to [use Quilkin](./docs/using.md).
Expand Down
2 changes: 2 additions & 0 deletions build/templates/release-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
- [ ] Reset checklist back to "run `make` to submit the cloud build", and start from there again.
- [ ] Run `cd macros && cargo publish --dry-run --allow-dirty` and ensure there are no issues.
- [ ] Run `cargo publish --dry-run --allow-dirty` and ensure there are no issues.
- [ ] Add a release item to README.md "Documentation" > "Releases" list with related links in reverse chronological
order.
- [ ] Submit these changes as a PR, and merge with approval.
- [ ] Create a [Github release](https://github.com/googleforgames/quilkin/releases/new) using the
[Github release template](./github-release.md).
Expand Down

0 comments on commit 8b37493

Please sign in to comment.