From 10f895708024632f5ac3f4630a02f28a3f297fe9 Mon Sep 17 00:00:00 2001 From: Luca Foppiano Date: Thu, 7 Sep 2023 12:22:21 +0900 Subject: [PATCH] restructuring the documentation --- docs/index.md | 6 ++++++ docs/{readme.md => technical-documentation.md} | 0 mkdocs.yml | 3 ++- 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/index.md rename docs/{readme.md => technical-documentation.md} (100%) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..f04bf0a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,6 @@ +# SuperCon 2 documentation + +- [Guidelines](guidelines/guidelines.md) +- [Technical documentation](technical-documentation.md) +- [Data workflow](data_workflow/readme.md) + diff --git a/docs/readme.md b/docs/technical-documentation.md similarity index 100% rename from docs/readme.md rename to docs/technical-documentation.md diff --git a/mkdocs.yml b/mkdocs.yml index bd4cc7d..79121f8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,4 +8,5 @@ plugins: theme: name: readthedocs nav: - - Home: 'guideline/guidelines.md' \ No newline at end of file + - Home: 'Index.md' + - Guidelines: 'guidelines/guidelines.md' \ No newline at end of file