Skip to content
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

Documentation snapshot/release README.md section #348

Merged
merged 1 commit into from
Jul 27, 2021
Merged

Documentation snapshot/release README.md section #348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
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
View file
Open in desktop
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