docs: improve readmes for cmd and template components
This commit is contained in:
@@ -1,8 +1,14 @@
|
|||||||
# cmd
|
# cmd
|
||||||
|
|
||||||
Executables live here.
|
Application entrypoints.
|
||||||
|
|
||||||
| binary | purpose |
|
| binary | purpose |
|
||||||
| ------------ | ----------------- |
|
| ------------ | --------------------------------- |
|
||||||
| `cmd/server` | web server |
|
| `cmd/server` | HTTP server and worker processes |
|
||||||
| `cmd/user` | user creation CLI |
|
| `cmd/user` | User management CLI |
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Each subdirectory is a `package main` that compiles to a standalone binary.
|
||||||
|
- Shared logic lives in `internal/` or `pkg/`, not in `cmd/`.
|
||||||
|
- Configuration is read from environment variables — see each binary's `main.go` for the full list.
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
# Components Index
|
# Components
|
||||||
|
|
||||||
|
Reusable Go template components.
|
||||||
|
|
||||||
## Available Templates
|
## Available Templates
|
||||||
|
|
||||||
@@ -16,18 +18,23 @@
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
All components are exposed as Go templates. Import by name:
|
Components are rendered with `{{template "name" .}}`. Props follow a keyword convention:
|
||||||
|
|
||||||
```gohtml
|
```gohtml
|
||||||
{{template "anime_card" dict "Anime" .Data "WithActions" true}}
|
{{template "anime_card" dict "Anime" .Data "WithActions" true}}
|
||||||
{{template "navigation" dict "CurrentPath" .CurrentPath}}
|
{{template "navigation" dict "CurrentPath" .CurrentPath}}
|
||||||
{{/* header removed */}}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Props Convention
|
## Props Convention
|
||||||
|
|
||||||
Components accept a `dict` with named keys:
|
Components receive a `dict` with named keys — no positional arguments, no implicit state.
|
||||||
|
|
||||||
- `dict "Key" .Value "Key2" .Value2`
|
```
|
||||||
|
dict "Key" .Value "Key2" .Value2
|
||||||
|
```
|
||||||
|
|
||||||
This keeps prop names explicit and self-documenting.
|
## Adding a component
|
||||||
|
|
||||||
|
1. Create `<name>.gohtml` in this directory.
|
||||||
|
2. Register it in `template_fs.go` if not already picked up by the embed glob.
|
||||||
|
3. Wire it into the page template.
|
||||||
|
|||||||
Reference in New Issue
Block a user