hexolan/stocklet
1
0
Fork 0
mirror of https://github.com/hexolan/stocklet.git synced 2026-03-26 11:41:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: initial commit

Browse Source
This commit is contained in:
Declan Teevan
2024-04-16 22:27:52 +01:00
commit 531b5dabe2
194 changed files with 27071 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/README.md Normal file
View File

@@ -0,0 +1,18 @@
# Stocklet Docs
## Table of Contents
* [Repository Overview](/README.md)
* [Documentation: Overview](/docs/README.md)
* [Documentation: Events](/docs/EVENTS.md)
* [Documentation: Feature Roadmap](/docs/ROADMAP.md)
## Formatting, styling, etc
The code has been formatted using [`gofmt`](https://pkg.go.dev/cmd/gofmt).
The protobuf schema files have been formatted using [`buf format`](https://buf.build/docs/reference/cli/buf/format).
The markdown files have been linted and formatted using [markdownlint](https://github.com/DavidAnson/markdownlint).
I used [PlantUML](https://plantuml.com/) as the tool to help make the diagrams. The PlantUML files are avaliable alongside the resulting images: [`/docs/imgs/overview.plantuml`](/docs/imgs/overview.plantuml) and [`/docs/imgs/placeordersaga.plantuml`](/docs/imgs/placeordersaga.plantuml)