Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Submit feedback
    • Contribute to GitLab
  • Sign in
P
purescript-gargantext
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
  • Issues 140
    • Issues 140
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 3
    • Merge Requests 3
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Charts
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • gargantext
  • purescript-gargantext
  • Issues
  • #742

Closed
Open
Opened May 15, 2025 by Karen Konou@karenkonou
  • Report abuse
  • New issue
Report abuse New issue

Developer documentation

Currently, the documentation for the frontend is incomplete, scattered in several places and hard to find. This makes onboarding for new developers difficult, as we use several in-house libraries (such as Reactix and Toestand) that developers need to be familiar with before they can contribute.

I think the following steps could help alleviate the issue:

  • Create a new centralized documentation repository, maybe hosted at docs.gargantext.org, built using something like mkdocs. This should be linked prominently in the project readme to be easy to find.

The documentation could include the following:

  • A reference of Reactix and Toestand, including examples and comparisons to vanilla JS/TS and React to help developer familiarity
  • An explanation of some of the architectural decisions and coding best practices
  • An explanation of the testing framework (when implemented)

In the future, this could also be extended to document the backend, and matters such as contribution guidelines etc.

An alternative could be hosting the documentation on gargantext itself but that might create barriers for access and editing (vs being built from markdown files in a git repo)

Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
1
Labels
toDiscuss
Assign labels
  • View project labels
Reference: gargantext/purescript-gargantext#742