From 1093da4a392913687e855be640e4e4edc0174a37 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Sun, 12 Mar 2023 20:46:32 +0100 Subject: [PATCH] docs: Move 'Notes' to design docs Signed-off-by: David Mehren --- docs/content/dev/{ => design_docs}/notes.md | 4 ++++ docs/mkdocs.yml | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) rename docs/content/dev/{ => design_docs}/notes.md (95%) diff --git a/docs/content/dev/notes.md b/docs/content/dev/design_docs/notes.md similarity index 95% rename from docs/content/dev/notes.md rename to docs/content/dev/design_docs/notes.md index 655407705..1b82b9ddd 100644 --- a/docs/content/dev/notes.md +++ b/docs/content/dev/design_docs/notes.md @@ -1,5 +1,9 @@ # Notes +!!! 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. + Each note in HedgeDoc 2 contains the following information: - publicId (`b604x5885k9k01bq7tsmawvnp0`) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0c565c236..46295df74 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -22,7 +22,7 @@ nav: - Development: - '2.0 Development': dev/2.0.md - Design Documents: - - Notes: dev/notes.md + - Notes: dev/design_docs/notes.md - 'User Profiles & Authentication': dev/design_docs/user_profiles.md - Configuration: dev/design_docs/config.md - 'Writing Docs': dev/documentation.md