Skip to content

doc: add contract doc for rfc 1299 - #1361

Merged
Teingi merged 3 commits into
oceanbase:masterfrom
Alanxtl:adddoc
Sep 2, 2026
Merged

Teingi merged 3 commits into
oceanbase:masterfrom
Alanxtl:adddoc

Conversation

@Alanxtl

@Alanxtl Alanxtl commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Which issue or RFC does this PR close?

This PR does not close #1298. It documents the contract from RFC PR #1299, which tracks issue #1298.

Rationale for this change

The host-visible integration diagnostics contract needs a single documented reference so plugin implementations and reviews use the same failure classifications, output format, privacy rules, fail-open behavior, and deduplication expectations.

What changes are included in this PR?

  • Add the English contract:
    • docs/en/development/plugin-contract.md
  • Add the Chinese contract:
    • docs/zh/development/plugin-contract.md
  • Add both documents to the Development navigation in zensical.toml.
  • Document:
    • authentication_failed, version_mismatch, server_unavailable, and invalid_response
    • Diagnostic JSON fields and examples
    • Host-specific output channels
    • Fail-open and privacy requirements
    • Bounded/deduplicated presentation
    • Plugin implementation conventions for this RFC
    • Required test matrix and out-of-scope items

Are there any user-facing changes?

Documentation-only change. There are no runtime, API, persistence-format, or migration changes.

How was this change tested?

make docs-test

The strict documentation build completed successfully with no issues.

AI usage statement

This documentation was prepared with OpenAI Codex using the GPT-5 model. The final scope, wording, links, and documentation build were reviewed in the repository.

@Teingi
Teingi merged commit 021847a into oceanbase:master Sep 2, 2026
12 checks passed
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.

Tracking Issue: local Server availability and service installation

1 participant