search

CottageLabs / edges

Data query, manipulation, search and visualisation front-end library
MIT License
8 stars 7 forks source link

Introduce code component/renderer documentation #35

Open richard-jones opened 6 months ago

richard-jones commented 6 months ago

Find a good way to document the code so that it's easy for developers to pick up.

Acceptance Criteria

varadekd commented 5 months ago

@richard-jones

I have investigated few documentation tools that can be used by us for creation and maintenance of the documentation for edges. Here is the list

  1. Gitbook
  2. Notion
  3. Basecamp
  4. Github Wiki

IMO, we should use Gitbook, it is easy to use and also supports version controlling either from Github or Gitlab. A sample documentation can be read here: https://kushagras-learning.gitbook.io/solr9_nested_and_graph