Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce code component/renderer documentation #35

Open
richard-jones opened this issue Mar 28, 2024 · 1 comment
Open

Introduce code component/renderer documentation #35

richard-jones opened this issue Mar 28, 2024 · 1 comment

Comments

@richard-jones
Copy link
Member

  • PR: [when the PR is created, put a link to it here. DO NOT use the "linked PR" feature]

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

Acceptance Criteria

  • Code is documented
  • Documentation is publishable as a website
@varadekd
Copy link
Contributor

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants