[Documentation]: Graphology JSON tutorial

Open Beginner friendly
#15 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start with gephi-lite/docs/user-manual/file-formats.md and the referenced en.json entry; review the existing file-format wording and workspace JSON schema link. Done means the manual explains Graphology JSON with a small Python generation tutorial and provides examples or links that help users create large input data.

Written by the indexing model from the issue text.

Description

Issue Type

Documentation Suggestion

Documentation Area

Gephi Lite - User Manual

Description

It is not clear how to generate input data with thousands of nodes for use with Gephi Lite.

The import dialog https://lite.gephi.org/v1.0.2/ says that "GEXF, GRAPHML or Graphology JSON are supported" with no links to format examples.

Image

The text could link to documentation https://docs.gephi.org/lite/user-manual/file-formats which doesn't have examples and doesn't mention Graphology JSON, but has a link to "Gephi Lite workspace" JSON schema.

Some quick tutorial would be nice to get started with generating the simple JSON (with Python) for use with Gephi Lite.

Location (if applicable)

https://github.com/gephi/gephi-documentation/blob/master/gephi-lite/docs/user-manual/file-formats.md

https://github.com/gephi/gephi-lite/blob/d906a957a23bbc3ed02c70be34816313f4f304e6/packages/gephi-lite/src/locales/en.json#L332

Additional Context

No response

Dominant language
MDX
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from gephi/gephi-documentation

All issues in gephi/gephi-documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.