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.

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

chore: move dev doc in .docs #150

Merged
merged 3 commits into from
Oct 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/dev/release/README.md → .docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This docs contains informations for releasing releasing.

Creating a release can be done by pushing a tag to the GitHub repository (begining with `v`).

The [release workflow](../../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts.
The [release workflow](../.github/workflows/release.yaml) will take care of creating the GitHub release and will publish artifacts.

```shell
VERSION="v0.1.0"
Expand All @@ -18,8 +18,8 @@ git push origin $TAG

## Release notes

Release notes for the `main` branch lives in [main.md](../../.release-notes/main.md).
Release notes for the `main` branch lives in [main.md](../.release-notes/main.md).

Make sure it is up to date and rename the file to the version being released.

You can then copy [_template.md](../../.release-notes/_template.md) to [main.md](../../.release-notes/main.md) for the next release.
You can then copy [_template.md](../.release-notes/_template.md) to [main.md](../.release-notes/main.md) for the next release.
1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@

This documentation contains the following docs:

- [Dev docs](./dev/README.md)
- [User docs](./user/README.md)
6 changes: 0 additions & 6 deletions docs/dev/README.md

This file was deleted.

Loading