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

Improve documentation #292

Open
1 of 8 tasks
Chief-Rishab opened this issue Sep 27, 2022 · 0 comments · Fixed by #312
Open
1 of 8 tasks

Improve documentation #292

Chief-Rishab opened this issue Sep 27, 2022 · 0 comments · Fixed by #312
Assignees

Comments

@Chief-Rishab
Copy link
Member

Chief-Rishab commented Sep 27, 2022

Guardian documentation should have a Guide section with the following guides:

  • Create a troubleshooting guide.
  • Create a detailed policy creation guide that walks through detailed policy creation and covers all advanced features.
  • Add a deployment guide for adding a new provider on Guardian
  • Create a detailed appeal creation guide
  • Create a detailed deployment guide

Concepts:

  • Create a detailed concept guide for appeal, policy, and providers.
  • Update diagrams for better representation.

References:

  • Add config reference for server and client configs
@Chief-Rishab Chief-Rishab changed the title Docs: Create a troubleshooting guide Docs: Update guide reference pages Sep 27, 2022
@Chief-Rishab Chief-Rishab changed the title Docs: Update guide reference pages Docs: Add guide reference pages Sep 27, 2022
This was linked to pull requests Nov 8, 2022
@ravisuhag ravisuhag changed the title Docs: Add guide reference pages Improve documentation Nov 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants