mirror of
https://github.com/azaion/annotations.git
synced 2026-06-21 08:31:06 +00:00
chore: update autodev documentation for parent suite integration
Enhanced the protocols and state documentation to include references to parent suite documentation, specifying how to handle the existence of a parent `docs` directory. Updated the README to direct users to the unified suite documentation.
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
# Azaion.Annotations
|
||||
|
||||
.NET REST API for media, annotations, datasets, and settings.
|
||||
|
||||
## Documentation
|
||||
|
||||
The **canonical** description of this service (HTTP API, media flows, RabbitMQ sync, SSE, settings) is maintained with the rest of the suite:
|
||||
|
||||
**[suite/_docs/01_annotations.md](../_docs/01_annotations.md)**
|
||||
|
||||
That file is the product and integration reference for this repository. Update it when you change public contracts, queues, or behavior it documents.
|
||||
|
||||
If you use a standalone clone without the parent `suite` tree, open `01_annotations.md` from your checkout of the suite `_docs` folder (same content).
|
||||
Reference in New Issue
Block a user