From 31969c56eb6dabc9b6eabd16d41e7c8787825419 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Sun, 19 Mar 2023 17:00:50 +0100 Subject: [PATCH] docs: add missing design docs disclaimer Signed-off-by: David Mehren --- docs/content/dev/design_docs/api_auth.md | 4 ++++ docs/content/dev/design_docs/events.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/content/dev/design_docs/api_auth.md b/docs/content/dev/design_docs/api_auth.md index 7dfb812f4..30b00ef08 100644 --- a/docs/content/dev/design_docs/api_auth.md +++ b/docs/content/dev/design_docs/api_auth.md @@ -1,5 +1,9 @@ # 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 All requests to the public API require authentication using a [bearer token](https://datatracker.ietf.org/doc/html/rfc6750). diff --git a/docs/content/dev/design_docs/events.md b/docs/content/dev/design_docs/events.md index 81579727c..781aca560 100644 --- a/docs/content/dev/design_docs/events.md +++ b/docs/content/dev/design_docs/events.md @@ -1,5 +1,9 @@ # 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]. It's used to reduce circular dependencies between different services and inform these services about changes.