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

Restructure docs to add dedicated documentation per component #59

Open
akashsinghal opened this issue Mar 26, 2024 · 0 comments
Open

Restructure docs to add dedicated documentation per component #59

akashsinghal opened this issue Mar 26, 2024 · 0 comments

Comments

@akashsinghal
Copy link
Collaborator

Right now, our Custom Resources doc folder is the only place for specific details on each of the Ratify components. Ideally, we should have a more general folder per component which can explain the purpose of each (verifier, store, etc) and then provide some user examples and CLI configs. This would be separate from the existing Custom Resources folder of docs.

Along the same lines, the existing stores.md and verifiers.md document is outdated and outlines a generic functional requirement when Ratify was originally proposed in 2021. This is no longer helpful and is largely inaccurate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant