Skip to content

docs: align best-practices Profile example with Core - #38

Merged
bewaterhere-coder merged 2 commits into
mainfrom
docs/profile-example-contract-parity
Nov 1, 2026
Merged

bewaterhere-coder merged 2 commits into
mainfrom
docs/profile-example-contract-parity

Conversation

@bewaterhere-coder

Copy link
Copy Markdown
Owner

Summary

  • Remove the obsolete Profile JSON from the Chinese best-practices guide.
  • Point both language sections to the canonical docs/profile-example.json instead of maintaining duplicate examples.
  • Add a Core regression test that loads the published Profile example through the real inspect(..., profile_data=...) path and verifies the selected plugins and standards bindings.

Why

The Chinese guide used plugins plus an array of standard objects, while Core V1 accepts selected_plugins plus a standards path mapping. Users copying the guide would receive an invalid Profile. The README and canonical profile example already used the correct contract; the guide had drifted.

Boundaries

  • Documentation and regression test only; no runtime behavior or public API changes.
  • No plugin implementation work.
  • Findings remain advisory and non-blocking.

Validation

GitHub Actions: Python 3.10–3.13, MCP stdio E2E and Sample Project Advisory.

@bewaterhere-coder
bewaterhere-coder merged commit 66f808a into main Nov 1, 2026
6 checks passed
@bewaterhere-coder
bewaterhere-coder deleted the docs/profile-example-contract-parity branch November 1, 2026 11:11
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

Successfully merging this pull request may close these issues.

1 participant