docs: restructure into topical sections and add the four most-asked-for pages (#3044)
This commit is contained in:
parent
080f2a869d
commit
220d362112
1 changed files with 2403 additions and 343 deletions
|
|
@ -138,9 +138,10 @@ rather than adding new standalone sections.
|
|||
## Documentation
|
||||
|
||||
When a change affects public API or user-visible behaviour, update the relevant
|
||||
page(s) under `docs/` in the same PR. Docs are organised by topic
|
||||
(`tutorial/`, `client/`, `run/`, `advanced/`) — find the page covering the
|
||||
feature you touched rather than adding a new one.
|
||||
page(s) under `docs/` in the same PR. Docs are organised by the `nav:` sections
|
||||
in `mkdocs.yml` (Get started, Servers, Inside your handler, Running your server,
|
||||
Clients, Advanced), not by the on-disk directory names. Find the page covering
|
||||
the feature you touched in `mkdocs.yml` rather than adding a new one.
|
||||
|
||||
## Formatting & Type Checking
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue