github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-24 18:56:32 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: add missing design docs disclaimer

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2023-03-19 17:00:50 +01:00
parent b5e64880cd
commit 31969c56eb
2 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/content/dev/design_docs/api_auth.md
View file

@ -1,5 +1,9 @@
# API Authentication # API Authentication
!!! info "Design Document"
This is a design document, explaining the design and vision for a HedgeDoc 2
feature. It is not a user guide and may or may not be fully implemented.
## Public API ## Public API
All requests to the public API require authentication using a [bearer token](https://datatracker.ietf.org/doc/html/rfc6750). All requests to the public API require authentication using a [bearer token](https://datatracker.ietf.org/doc/html/rfc6750).

4
docs/content/dev/design_docs/events.md
View file

@ -1,5 +1,9 @@
# Events # Events
!!! info "Design Document"
This is a design document, explaining the design and vision for a HedgeDoc 2
feature. It is not a user guide and may or may not be fully implemented.
In HedgeDoc 2, we use an event system based on [EventEmitter2][eventemitter2]. In HedgeDoc 2, we use an event system based on [EventEmitter2][eventemitter2].
It's used to reduce circular dependencies between different services and inform these services about changes. It's used to reduce circular dependencies between different services and inform these services about changes.