tattle-made / feluda

A configurable engine for analysing multi-lingual and multi-modal content.

Home Page:https://tattle.co.in/products/feluda/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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:

  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