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

Move Documentation from Gatsby Docs to Wiki #314

Open
aatmanvaidya opened this issue May 13, 2024 · 0 comments
Open

Move Documentation from Gatsby Docs to Wiki #314

aatmanvaidya opened this issue May 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers level:feature priority:high size:3pt

Comments

@aatmanvaidya
Copy link
Collaborator

Some of the older documentation of Feluda is present in a Gatsby website in the docs folder.

Link to older documentation - feluda/docs

Documenting the codebase is always an ongoing task. However, for this issue, here are the specific deliverables:

  1. Transfer all documentation from the Gatsby website to the GitHub Wiki.
    • This will include moving all the existing pages from the website to the Wiki. Think of a effective way to structure new things on the Wiki.
  2. Create an Architecture page on the Wiki explaining the core parts of Feluda in brief. Add description for Operators, Store, Queue, Server, Config and Worker.
  3. Update the Home page of the Wiki with a Table of Contents linking to the right pages.
  4. Consider shortening the README.md and moving relevant content to the Wiki. Ensure README.md contains links to the Wiki where necessary.
  5. In the Worker documetation, for each Worker add
    • how the input and output looks like
    • add their dockerhub image tags

This issue will be worked on jointly with @aatmanvaidya

@aatmanvaidya aatmanvaidya added good first issue Good for newcomers level:feature documentation Improvements or additions to documentation priority:high size:3pt labels May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers level:feature priority:high size:3pt
Projects
None yet
Development

No branches or pull requests

1 participant