bcquality/docs/README.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Validate frontmatter and structure / validate (push) Has been cancelled
Improve partner onboarding and documentation navigation (#174)
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.7 KiB

BCQuality documentation

New to BCQuality? Start with the quick start. Install the plugin, discover its skills, and try an app review. No knowledge of BCQuality's internal protocol is needed.

Partner guides

Goal Guide
Review an app, file, changes, or branch Using BCQuality
Understand a report and its limitations Reading your results
Find a particular rule or example Knowledge by domain
Fix setup problems or report an incorrect finding Troubleshooting and support
Select layers, add company rules, or maintain a fork Customizing BCQuality
Add or improve shared knowledge Contributing

Integration and technical reference

These pages are for people building integrations or maintaining skills, not prerequisites for using the plugin.

Reference Purpose
How agents consume BCQuality Architecture, repository structure, routing, and delivery of findings.
Standalone runner Optional model selection, scheduling, retries, and telemetry.
Global skills Host adapters versus internal protocol files.
Entry Task context and skill dispatch.
READ Knowledge schema, applicability, and precedence.
DO Action-skill format and structured output contract.
WRITE Knowledge-authoring rules.
Review evaluation Sample conventions, fixture preparation, and scoring.