We should add markdown documentation to AVC similar to what we have in APIView.
- Should be located in the
apiview-copilot/docs/ folder
overview.md provides an overview of the architecture with links, as appropriate to sub-documentskb.md descriibes the architecture of the Knowledge Base and how the knowledge base works in practicemetrics.md describes the metrics we collect or report, why, and how to access themapi-review.md thoroughly describes the API review algorithm, including the purpose of all stages in the process. This will likely be reused often by agent callscli.md describes the CLI commands available for working with AVC locally.
We should add markdown documentation to AVC similar to what we have in APIView.
apiview-copilot/docs/folderoverview.mdprovides an overview of the architecture with links, as appropriate to sub-documentskb.mddescriibes the architecture of the Knowledge Base and how the knowledge base works in practicemetrics.mddescribes the metrics we collect or report, why, and how to access themapi-review.mdthoroughly describes the API review algorithm, including the purpose of all stages in the process. This will likely be reused often by agent callscli.mddescribes the CLI commands available for working with AVC locally.