chore: adding docs

This commit is contained in:
Daniel Noulet 2026-10-07 15:05:48 +02:00
parent 23816d00f7
commit 81c5112409
39 changed files with 7257 additions and 2 deletions

101
data/docs/go-fish.md Normal file
View file

@ -0,0 +1,101 @@
<!-- go-doc:generated:begin source=go-fish signature=7f744c2508fdc6f1c8a4f727d5ccb83b generated=2026-10-07 08:28 UTC -->
# go-fish
A web-based implementation of the classic Go Fish card game.
| | |
| --- | --- |
| Module | github.com/danyel/go-fish · go 1.21 · 6 Go files |
| Endpoints | 5 endpoints |
| Components | 0 component directories |
| Tests | none detected |
| Go lines | 645 lines |
> Everything between the generated markers is rewritten by every sync. Notes written outside the markers are kept.
## For Users
### What this application does
A web-based implementation of the classic Go Fish card game.
The project ships its own README at `README.md`, which is the long form of this page. The three audience tabs split the same facts three ways so you only read the part that concerns you.
### Reading this in go-doc
Open the page and pick the tab that matches you:
- **User** — you use the finished application. This section is all you need.
- **Operator** — you run it. Configuration, ports and deployment notes are under that tab.
- **Developer** — you integrate with it or change it. The API and layout tables are under that tab.
The feedback panel stores a note per audience, tagged with your badge, so operators and developers can see which audience raised it.
### Where the original documentation lives
This project already carries 1 Markdown document. They stay in the project repository: this page points at them instead of copying them, so there is always exactly one copy of the truth.
| Document | Size |
| --- | --- |
| `README.md` | 1829 bytes |
---
## For Operators
### Running it locally
This project has no root Makefile, so the binary or container is run directly.
### Configuration
No environment variables were found in the source or in a `.env` file.
### Network surface
No explicit port declaration was found. Check the README and the compose file before assuming a default.
### Deployment artefacts
No Helm chart was found, so deployment is expected to be plain Docker or a managed platform.
> No Dockerfile was found at any level.
---
## For Developers
### Module layout
- go.mod — module github.com/danyel/go-fish, go 1.21, 1 direct and 0 indirect dependencies
### HTTP API
Every route registration found in the source:
| Method | Path | Handler |
| --- | --- | --- |
| `GET` | `/` | `homeHandler` |
| `POST` | `/ask` | — |
| `POST` | `/join` | — |
| `GET` | `/play/{id}` | — |
| `GET` | `/waiting` | — |
### Direct dependencies
- `github.com/go-chi/chi/v5` v5.0.0
### Directory map
| Directory | Files | Lines | Likely purpose |
| --- | --- | --- | --- |
| `internal/` | 5 | 353 | unimportable application internals |
| `web/` | 3 | 0 | frontend assets |
| `cmd/` | 1 | 292 | binary entry points |
### Languages
- **Go** — 6 files, 645 lines
- **HTML** — 3 files, 251 lines
- **Markdown** — 1 file, 71 lines
<!-- go-doc:generated:end -->