Move Documentation from Gatsby Docs to Wiki
aatmanvaidya opened this issue · comments
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:
- 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.
- Create an
Architecture
page on the Wiki explaining the core parts of Feluda in brief. Add description forOperators
,Store
,Queue
,Server
,Config
andWorker
. - Update the Home page of the Wiki with a
Table of Contents
linking to the right pages. - Consider shortening the
README.md
and moving relevant content to the Wiki. EnsureREADME.md
contains links to the Wiki where necessary. - 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