Fix docu page

nomad-coe · Mar 27, 2024 · 144782f · 144782f
1 parent d38e91d
commit 144782f
Show file tree

Hide file tree

Showing 9 changed files with 5 additions and 95 deletions.
diff --git a/docs/explanation/explanation.md b/docs/explanation/explanation.md
diff --git a/docs/how_to/contribute_to_the_documentation.md b/docs/how_to/contribute_to_the_documentation.md
diff --git a/docs/how_to/contribute_to_this_plugin.md b/docs/how_to/contribute_to_this_plugin.md
diff --git a/docs/how_to/install_this_plugin.md b/docs/how_to/install_this_plugin.md
diff --git a/docs/how_to/use_this_plugin.md b/docs/how_to/use_this_plugin.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,50 +1,4 @@
-# Welcome to the `nomad-parser-plugin-example` documentation
+# Welcome to the `nomad-parser-magres` documentation
 
-Short summary about your plugin
-
-## Introduction
-
-This is a example plugin.
-
-!!! note "Attention"
-    Please update the document with relevant information specific to your plugin.
-
-<div markdown="block" class="home-grid">
-<div markdown="block">
-
-### Tutorial
-
-A series of tutorials will guide you through the main functionality of `nomad-parser-example`.
-
-- [Tutorial](tutorial/tutorial.md)
-
-</div>
-<div markdown="block">
-
-### How-to guides
-
-How-to guides provide step-by-step instructions for a wide range of tasks, with the overarching topics:
-
-- [Install this plugin](how_to/install_this_plugin.md)
-- [Use this plugin](how_to/use_this_plugin.md)
-- [Contribute to this plugin](how_to/contribute_to_this_plugin.md)
-- [Contribute to the documentation](how_to/contribute_to_the_documentation.md)
-
-</div>
-
-<div markdown="block">
-
-### Explanation
-
-The explanation [section](explanation/explanation.md) provides background knowledge on this plugin.
-
-</div>
-<div markdown="block">
-
-### Reference
-
-The reference [section](reference/references.md) includes all CLI commands and arguments, all configuration options,
-the possible schema annotations and their arguments, and a glossary of used terms.
-
-</div>
-</div>
+!!! warning
+    This page is still under construction.
diff --git a/docs/reference/references.md b/docs/reference/references.md
diff --git a/docs/tutorial/tutorial.md b/docs/tutorial/tutorial.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,19 +1,10 @@
 site_name: Documentation
 site_description: |
-  The documentation for NOMAD parser plugin example
+  The documentation for the NOMAD parser for magres files.
 site_author: The NOMAD Authors
-repo_url: https://github.com/nomad-coe/nomad-parser-plugin-example
-
+repo_url: https://github.com/nomad-coe/nomad-parser-magres
 nav:
   - Home: index.md
-  - Tutorial: tutorial/tutorial.md
-  - How-to guides:
-      - Install this Plugin: how_to/install_this_plugin.md
-      - Use this Plugin: how_to/use_this_plugin.md
-      - Contribute to this plugin: how_to/contribute_to_this_plugin.md
-      - Contribute to the documentation: how_to/contribute_to_the_documentation.md
-  - Explanation: explanation/explanation.md
-  - Reference: reference/references.md
 plugins:
   - search
 theme: