Add Gephi Toolkit documentation for Gephi 0.11.2 - #14
Open
seinecle wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new, structured Gephi Toolkit documentation section targeting Gephi Toolkit 0.11.2 (Java 17+), including end-to-end guidance from setup through import/export, graph manipulation, filtering/analysis/appearance, layouts/preview/export, dynamic graphs/workspaces, concurrency considerations for server use, and troubleshooting, plus a runnable sample GEXF input.
Changes:
- Introduces a multi-page Gephi Toolkit guide with task-oriented chapters and conceptual background.
- Adds a bundled
input.gexfsample file used by the “Getting started” runnable example. - Registers the new documentation section in Docusaurus via
_category_.json.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| gephi-desktop/docs/Gephi_Toolkit/category.json | Adds the Docusaurus sidebar category entry for the Toolkit docs section. |
| gephi-desktop/docs/Gephi_Toolkit/index.md | Adds the Toolkit landing page, scope, and reference links. |
| gephi-desktop/docs/Gephi_Toolkit/getting-started.md | Adds a step-by-step Maven + Java 17 “first pipeline” tutorial. |
| gephi-desktop/docs/Gephi_Toolkit/core-concepts.md | Explains Lookup/controllers, and the project/workspace/container/model lifecycle. |
| gephi-desktop/docs/Gephi_Toolkit/graph-model.md | Documents creating graphs and manipulating structure/attributes via the Graph API. |
| gephi-desktop/docs/Gephi_Toolkit/import-export.md | Documents import configuration, container processing, and export patterns (file/memory/visible graph). |
| gephi-desktop/docs/Gephi_Toolkit/filtering-analysis-appearance.md | Documents filter views, statistics execution, and mapping data to visual properties. |
| gephi-desktop/docs/Gephi_Toolkit/layout-and-preview.md | Documents running layouts, configuring preview, and exporting rendered output. |
| gephi-desktop/docs/Gephi_Toolkit/dynamic-graphs-and-workspaces.md | Documents temporal configuration, generators, snapshot merging, and workspace handling. |
| gephi-desktop/docs/Gephi_Toolkit/concurrency-and-server-applications.md | Documents request isolation hazards and recommended locking/process isolation approaches. |
| gephi-desktop/docs/Gephi_Toolkit/troubleshooting.md | Adds common failure-mode guidance for lookup/classpath/import/export/layout/preview issues. |
| gephi-desktop/docs/Gephi_Toolkit/input.gexf | Adds a bundled example graph file used by the runnable tutorial. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+52
to
+54
| - [Gephi Toolkit main page](https://gephi.org/toolkit/) | ||
| - [Gephi Toolkit Javadoc](https://javadoc.io/doc/org.gephi/gephi-toolkit/latest/index.html) | ||
| - [Gephi Toolkit releases](https://github.com/gephi/gephi-toolkit/releases) |
|
|
||
| This graph lock protects a graph operation; it does not protect the global project lifecycle. Use the application-level critical section or process isolation for that broader boundary. | ||
|
|
||
| See the [`ProjectController` 0.11.2 contract](https://javadoc.io/doc/org.gephi/gephi-toolkit/latest/org/gephi/project/api/ProjectController.html) for project and workspace lifecycle behavior. |
|
|
||
| Choose directedness and other parameters deliberately; they change the meaning of the result. Depending on the algorithm, executing against the model may use its visible graph. Decide whether filtering is part of the analysis before running a statistic. | ||
|
|
||
| Some metrics are executed through `StatisticsController`, especially when the controller coordinates execution or progress. Follow the API used by the concrete statistic and consult the [0.11.2 Javadoc](https://gephi.org/gephi-toolkit/0.11.2/apidocs/). |
| 3. the algorithm, filter, transformer, importer, or exporter to configure; | ||
| 4. the method that executes it. | ||
|
|
||
| The [Javadoc](https://javadoc.io/doc/org.gephi/gephi-toolkit/latest/index.html) documents API contracts. The [Toolkit demos](https://github.com/gephi/gephi-toolkit-demos) show which implementations are normally instantiated directly and which services come from `Lookup`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a structured Gephi Toolkit guide for Gephi 0.11.2 and Java 17, covering setup, graph models, import and export, filtering and analysis, layouts and preview, dynamic graphs, workspaces, concurrency, server applications, and troubleshooting. Includes a runnable GEXF example. Validation: the Docusaurus desktop production build succeeds.