mirror of
https://github.com/calibrain/shelfmark.git
synced 2026-11-14 23:08:26 +00:00
splitsec2
0a7e114681
Nothing in the developer docs says where a new route goes, so the next contributor adds it to `main.py` again. This writes down the convention from Discussion #1536: a new route group gets its own `register_<group>_routes` module under `shelfmark/core/`, and `main.py` calls it once. It is one paragraph on a new page, `docs/dev/routes.md`, with a line in the developer index. It also says that a few older routes are still in `main.py` and are being moved out one group at a time. The route moves in that discussion will follow what this says, so this goes first.
9 lines
503 B
Markdown
9 lines
503 B
Markdown
# Developer Documentation
|
|
|
|
Guides for adding to Shelfmark.
|
|
|
|
- [Release Sources Plugin Guide](release-sources-plugin-guide.md): add a source that searches for releases and a handler that downloads them
|
|
- [Plugin Settings Guide](plugin-settings.md): add settings tabs and fields for a plugin to the Settings UI
|
|
- [Adding Routes](routes.md): where a new API route goes, and how a route module gets what it needs
|
|
- [Metadata Providers](../../shelfmark/metadata_providers/README.md): add a metadata provider
|