Merge pull request #7 from gephi/gephi-week-2025-multiple

[Gephi week] Updated documentation for Gephi and Gephi Lite

Author: mbastian

.github/ISSUE_TEMPLATE/documentation-issue.yml

@@ -0,0 +1,68 @@
+name: Documentation Issue
+description: Suggest improvements or report problems with the Gephi documentation
+title: "[Documentation]: "
+labels: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help improve Gephi's documentation!
+
+  - type: dropdown
+    id: issue-type
+    attributes:
+      label: Issue Type
+      description: What type of issue are you submitting?
+      options:
+        - Documentation Suggestion
+        - Report a Problem
+        - Question about Documentation
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: documentation-area
+    attributes:
+      label: Documentation Area
+      description: Which part of the documentation does this concern?
+      options:
+        - Gephi Desktop - User Manual
+        - Gephi Desktop - Plugin Development
+        - Gephi Desktop - Developer Documentation
+        - Gephi Lite - User Manual
+        - Gephi Lite - Integration/Deployment
+        - Website/General
+        - Not sure
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please provide a clear and detailed description of your suggestion or the problem you encountered.
+      placeholder: |
+        - What did you expect to find in the documentation?
+        - What is missing, unclear, or incorrect?
+        - What improvements would you suggest?
+    validations:
+      required: true
+
+  - type: textarea
+    id: location
+    attributes:
+      label: Location (if applicable)
+      description: If this concerns a specific page, please provide the URL or page title.
+      placeholder: "e.g., https://gephi.org/docs/... or 'Import CSV Data' page"
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context, screenshots, or examples that might be helpful.
+    validations:
+      required: false
+

.gitignore

@@ -1,8 +1,8 @@
 # Dependencies
-/node_modules
+node_modules
 
 # Production
-/build
+build
 
 # Idea
 .idea

README.md

@@ -1,41 +1,46 @@
-# Website
+# Gephi documentations websites
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This repository is for the gephi projects documentation, with one site for Gephi (desktop) and an other one for Gephi-Lite.
+In the futur, we can have others. 
 
-### Installation
+Each of those sites are a docusaurus instance. 
 
-```
-$ yarn
-```
+## How to use it 
 
-### Local Development
+It's a javascript mono-repo project.
 
+Before all, you need to install the project's 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.
+There are 3 main commands in the project
 
-### Build
+### npm start
 
 ```
-$ yarn build
+$> npm start
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+It starts the project in dev mode, so you will have the hot reload feature.
+Under the hood, it starts the docusaurus instance for geph & gephi-lite, as well as a vite server that serves the root index.html files and has a proxy for each docusaurus instance.
 
-### Deployment
+Open the url http://localhost:5173
 
-Using SSH:
+### npm run build
+
+It builds the static website inside the `/build` directory. 
 
 ```
-$ USE_SSH=true yarn deploy
+$> npm run build
 ```
 
-Not using SSH:
+### npm run preview
+
+It runs a webserver that serves the `/build` directory. So it should be used after a `npm run build` to preview the build
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+$> npm run preview
 ```
 
-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.
+Open the url http://localhost:5174