diff --git a/README.md b/README.md
index 0c6c2c27be92d0755ffa320a8c2222174ce39299..91f495c7d30836775d0c0259b188edf05b2b4717 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,60 @@
-# Website
+# Welcome to UnHIDE Docs
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+This project contains the user documentation for all of unHIDEs user interfaces. This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. The documentation is written in Markdown which is then compiled into a static website by Docusaurus.
-### Installation
+## Getting Started
+
+### Dependencies
+
+Node.js v18.0 or above
+
+Check if Node.js is installed on your computer by running the following command in a terminal
```
-$ yarn
+node --version
```
-### Local Development
+Unless the prompt answers with a `v18.0.0` or higher, you do not have the required dependency. Please follow the steps below where we first install [Node Version Manager (NVM)](https://github.com/nvm-sh/nvm). This helps install the latest version of Node on your machine and you can further use it to install and switch between different versions of Node.js if you need to use it for other projects.
+
+Follow the [installation steps](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) and confirm that you fulfill the dependency requirements.
+
+Now clone the repository and move to its root level (where you find `package.json`) and open a terminal on this level
+
+### Install project dependencies
```
-$ yarn start
+$ npm install
```
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
+### Run locally
```
-$ yarn build
+$ npm run start
```
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-### Deployment
+### Build for production
-Using SSH:
+Do not use the following command when you are developing (adding new content) on your local machine. This is only relevant for deployment.
```
-$ USE_SSH=true yarn deploy
+$ npm run build
```
-Not using SSH:
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
+## Adding Documentation
+
+The project has already been set up for direct use. For now, please just add content to the respective markdown files that are found in `/docs`. The relevant markdown file can be found easily as the folder has been structured as per the websites layout (actually, the websites layout is dependent on folder structure). The folder structure along with descriptive naming convention for the document should make it clear which markdown file might be appropriate. If you need to add new pages, or need content to be structured a certain way - please get in touch with [Ms.Fiona D'Mello](mailto:f.dmello@fz-juelich.de).
+
+## Acknowledgement
+
+<div>
+<img style="vertical-align: middle;" alt="HMC Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png" width=50% height=50% />
+
+<img style="vertical-align: middle;" alt="FZJ Logo" src="https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png" width=30% height=30% />
+</div>
+<br />
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+The project is implemented by the **H**elmholtz **M**etadata **C**ollaboration (**HMC**) an incubator platform of the Helmholtz Association. It is funded by the Helmholtz Association. The project is deployed by **J**ülich **S**uper **C**omputing Cloud (**JSC Cloud**) at **F**orschungs**z**entrum **J**ülich GmbH (**FZJ**), an organization that is part of the Helmholtz Association. We thank all these stakeholders for their support and contribution to this projects development.
diff --git a/docs/guides/SPARQL/intro.md b/docs/guides/sparql/intro.md
similarity index 100%
rename from docs/guides/SPARQL/intro.md
rename to docs/guides/sparql/intro.md
diff --git a/docs/guides/Web API/intro.md b/docs/guides/web-api/intro.md
similarity index 100%
rename from docs/guides/Web API/intro.md
rename to docs/guides/web-api/intro.md
diff --git a/docs/guides/Web UI/intro.md b/docs/guides/web-ui/intro.md
similarity index 74%
rename from docs/guides/Web UI/intro.md
rename to docs/guides/web-ui/intro.md
index 0693ddcd5b53524ea41acb8e9624644916bb5003..6ed4c7331bf9229c77f93819651aee1e48c2fd6b 100644
--- a/docs/guides/Web UI/intro.md
+++ b/docs/guides/web-ui/intro.md
@@ -1,6 +1,6 @@
---
displayed_sidebar: guidesSidebar
-sidebar_position: 1
+sidebar_position: 2
---
## WEB UI guide
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 8ccfaea04ca15b8ca7cdd4c370e1f9767ac04f0a..3ad5e024d03e8cce1e06f09b55a4675431fda523 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -74,38 +74,50 @@ const config: Config = {
title: "Docs",
items: [
{
- label: "Tutorial",
+ label: "Docusaurus Tutorial",
to: "/docs/docusaurus-tutorials/intro",
},
+ {
+ label: "About",
+ to: "/docs/about/introduction",
+ },
+ {
+ label: "Guides",
+ to: "/docs/guides",
+ },
+ {
+ label: "Community",
+ to: "/docs/community/partners",
+ },
],
},
{
- title: "Community",
+ title: "Disclaimers",
items: [
{
- label: "Stack Overflow",
- href: "https://stackoverflow.com/questions/tagged/docusaurus",
+ label: "Privacy protection",
+ href: "https://www.fz-juelich.de/en/privacy-policy",
},
{
- label: "Discord",
- href: "https://discordapp.com/invite/docusaurus",
+ label: "Legal Information",
+ href: "https://www.fz-juelich.de/en/legal-notice",
},
{
- label: "Twitter",
- href: "https://twitter.com/docusaurus",
+ label: "Accessibility",
+ href: "https://www.fz-juelich.de/en/declaration-of-accessibility",
},
],
},
{
- title: "More",
+ title: "Projects",
items: [
{
- label: "Blog",
- to: "/blog",
+ label: "UnHIDE Web",
+ href: "https://codebase.helmholtz.cloud/hmc/hmc-public/unhide/unhide-ui",
},
{
- label: "GitLab",
- href: "https://github.com/facebook/docusaurus",
+ label: "UnHIDE Data Harvesting",
+ href: "https://codebase.helmholtz.cloud/hmc/hmc-public/unhide/data_harvesting",
},
],
},
diff --git a/sidebars.ts b/sidebars.ts
index d558795bd1ff33597fd2c99559d68cb044dce2bf..1d3795a8ab0b7001e271d28dec3f7ff5fbc61010 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -14,7 +14,36 @@ const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{ type: "autogenerated", dirName: "docusaurus-tutorials" }],
aboutSidebar: [{ type: "autogenerated", dirName: "about" }],
- guidesSidebar: [{ type: "autogenerated", dirName: "guides" }],
+ guidesSidebar: [
+ "guides/index",
+ {
+ type: "category",
+ label: "Web UI",
+ link: {
+ type: "generated-index",
+ },
+ collapsed: true,
+ items: ["guides/web-ui/intro"],
+ },
+ {
+ type: "category",
+ label: "Web API",
+ link: {
+ type: "generated-index",
+ },
+ collapsed: true,
+ items: ["guides/web-api/intro"],
+ },
+ {
+ type: "category",
+ label: "SPARQL",
+ link: {
+ type: "generated-index",
+ },
+ collapsed: true,
+ items: ["guides/sparql/intro"],
+ },
+ ],
communitySidebar: [{ type: "autogenerated", dirName: "community" }],
};