Create documentation structure for tirith and bootstrap docs

[refeed]

Brainstorm about:

• What are the structures for the docs? (a good start would be to research readthedocs)
• Good docs examples
• Best if the docs is optimized for vector database for integration with the RAG

Update (22/04/2024):

• Find the right structure and write a concrete docs, would be great if we have multiple structure options to compare
  • Goal: optimized for RAG, readable for human

cc @samriddhi99

[ritikaaaa177]

Hi @refeed, please assign me this issue. I am excited to work on the documentation of tirith

[refeed]

Hi @ritikaaaa177 , thanks for your interest, we'll need to discuss that issue more with the internal team for now, when the issue is ready, we'll mark it as help wanted later. In the meantime, this task is also related to docs, but more to docstring, if you want to take it, I can help you https://github.com/StackGuardian/tirith/issues/90

[refeed]

Inspiration from: https://pypika.readthedocs.io/en/latest/index.html

• Intro (index page) -- explaining a little bit about Tirith, can be taken some from the [readme.md] (https://github.com/StackGuardian/tirith/blob/main/README.md) #170
• Installation #170
  • Linux
  • Windows
  • Mac
• Tirith Policies
  • Basic Structure
  • Error tolerance
  • Condition Type
  • Variables
  • Example Policies
• Tutorial
  • CLI usage
  • Integrating with CI/CD
  • Using the library for doing evaluations in Python code
  • (another real-world usecases)
• Providers
  • terraform_plan provider
  • json provider
  • kubernetes provider
  • ...
• Condition Types
  • Equals
  • LessThan
  • ...
• Contributing (Can be taken from CONTRIBUTING.md)
  • Developer install
  • Make a PR
  • Make a issues
  • Solving issues

[Aman1905]

hey @samriddhi99 @refeed please assign me this issue, would like to work on this

[refeed]

Hi @Aman1905 , sorry for the delay, please ignore my previous deleted comment. I think this can be a good task for bootstrapping the skeleton of the documentation, I'll assign you this

[Aman1905]

@refeed as per discussion, proceeding with the docusaurus, have started setting up the template of the documentation, will soon raise the PR

[refeed]

Thanks @Aman1905 ! I don't understand about the "please soon push the PR" part, is there anything that I should make a PR on?

[Aman1905]

hey @refeed apologies for the confusion here, it was will soon raise the PR I guess accidentally have wrote that

[Aman1905]

hey @refeed can you please merge this PR - https://github.com/StackGuardian/tirith/pull/177 in which I have set up the basic template of the documentation, and written the "getting started page". After you merge and deploy it, will keep on updating the other pages as well, also will have to update the URLs and other things too in the documentation

[refeed]

@Aman1905 alright, thanks!