Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Improve partner onboarding and documentation navigation

Browse source 
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: Copilot App <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Jesper Schulz-Wedde 2026-09-09 17:25:29 +02:00
parent a21edfec46
commit b6da405376
276 changed files with 1287 additions and 756 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/README.md
View file

@ -1,8 +1,32 @@
# Documentation
# BCQuality documentation
- [How agents consume BCQuality](agent-consumption.md) explains the operational
flow from Entry dispatch through structured findings and integration.
- [Build a lightweight standalone review runner](standalone-runner.md) explains
one concrete walk-up skill flow and how an external runner can add model
selection, concurrency, retries, and telemetry without moving orchestration
into BCQuality.
**New to BCQuality? Start with the [quick start](../README.md#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](using-bcquality.md) |
| Understand a report and its limitations | [Reading your results](using-bcquality.md#reading-your-results) |
| Find a particular rule or example | [Knowledge by domain](using-bcquality.md#knowledge-by-domain) |
| Fix setup problems or report an incorrect finding | [Troubleshooting and support](troubleshooting.md) |
| Select layers, add company rules, or maintain a fork | [Customizing BCQuality](customizing-bcquality.md) |
| Add or improve shared knowledge | [Contributing](contributing.md) |
## 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](agent-consumption.md) | Architecture, repository structure, routing, and delivery of findings. |
| [Standalone runner](standalone-runner.md) | Optional model selection, scheduling, retries, and telemetry. |
| [Global skills](../skills/README.md) | Host adapters versus internal protocol files. |
| [Entry](../skills/entry.md) | Task context and skill dispatch. |
| [READ](../skills/read.md) | Knowledge schema, applicability, and precedence. |
| [DO](../skills/do.md) | Action-skill format and structured output contract. |
| [WRITE](../skills/write.md) | Knowledge-authoring rules. |
| [Review evaluation](../evaluation/README.md) | Sample conventions, fixture preparation, and scoring. |