docs: add docs

Signed-off-by: kjuulh <contact@kjuulh.io>
This commit is contained in:
2023-08-02 14:11:29 +02:00
parent f7a6ea5d83
commit decdf5f777
5 changed files with 296 additions and 12 deletions

View File

@@ -1,17 +1,35 @@
# Welcome to MkDocs
# Cuddle docs
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
Cuddle Please is an extension to `cuddle`, it is a separate binary that can be executed standalone as `cuddle-please`, or in cuddle as `cuddle please`.
## Commands
The goal of the software is to be a `release-please` clone, targeting `gitea` instead of `github`.
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
The tool can be executed as a binary using:
## Project layout
```bash
cuddle please release # if using cuddle
# or
cuddle-please release # if using standalone
```
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
And when a release has been built:
```bash
cuddle please release
# or
cuddle-please release
```
cuddle will default to information to it available in git, or use a specific entry in `cuddle.yaml` called
```yaml
# ...
please:
name: <something>
# ...
# ...
```
or as `cuddle.please.yaml`
See docs for more information about installation and some such