Skip to content

Add the operator documentation site - #112

Merged
SaladDay merged 2 commits into
mainfrom
docs/final-manual
Sep 27, 2026
Merged

SaladDay merged 2 commits into
mainfrom
docs/final-manual

Conversation

@AllureCurtain

@AllureCurtain AllureCurtain commented Sep 25, 2026 •

Copy link
Copy Markdown
Collaborator

Add a standalone operator documentation site under apps/docs, reconciled against the current OpenAgentCore installation and API contracts. It separates the public /v1, Core administration /core/v1 and machine /api/v1 references, uses current canonical English operator guides, and provides Chinese reading notes linked to the complete guides. No credentials or live request playground are needed.

The site renders130 contract operations, checks their correspondence with registered routes, and verifies generated copies and219 local links. Swagger conversion preserves all281 nullable fields and their other constraints. API examples use reserved hosts, request controls are disabled, and the required docs checks use declared dependencies rather than ambient PyYAML. This docs commit does not change canonical contracts or Core execution code. The new check-docs target joins make check.

Validation at6e9c2761: independent review and correction review passed;17 Node and2 Python regressions, route/content/link/name checks and typecheck passed. Production build prerendered106 routes. Actual Chromium passed9 desktop routes, both language paths,390px mobile layout and read-only API checks with no external requests;5 screenshots were inspected/retained. The required exact-source full server gate passed at18:59:09 UTC, with the existing approved backend Playwright exclusion reported separately from this real docs browser check.

Final integration80e213bb is based on the unchanged error-foundation patch75bf4484 atop renamed mainf5fb8ec1. The Core reference and English guides are regenerated from that exact source; rendering logic, dependencies and UI are unchanged from the independently reviewed6e9c2761. Final focused generation,130-operation correspondence,219-link verification,17 Node+2 Python tests, typecheck and106-route build passed again; all81 generated/content files regenerated byte-identically. The same bounded actual Chromium check also passed on final80e213bb: nine desktop routes, English/Chinese paths,390px mobile layout, read-only reference controls and no external requests; final screenshots are retained. The complete combined foundation/docs server gate at80e213bb passed at19:31:17 UTC, including all required make-check targets with the approved backend Playwright exclusion stated separately from actual docs browser acceptance. This replaces the stale pre-rename site candidate; the old02ea6093 source remains preserved. Future reset/rollout and diagnostics documentation, plus the canonical console screenshot refresh, remain explicitly tracked in apps/docs/FOLLOW-UP.md and will be reconciled as those features land. No site deployment or intermediate release is claimed.

@SaladDay
SaladDay marked this pull request as draft September 27, 2026 18:35
@SaladDay
SaladDay changed the base branch from main to codex/rename-final-acceptance September 27, 2026 18:35
@SaladDay
SaladDay changed the base branch from codex/rename-final-acceptance to codex/config-error-foundation September 27, 2026 19:15
@SaladDay
SaladDay changed the base branch from codex/config-error-foundation to main September 27, 2026 19:27
@SaladDay
SaladDay marked this pull request as ready for review September 27, 2026 19:27
@SaladDay
SaladDay merged commit 3a82ccc into main Sep 27, 2026
4 of 7 checks passed
@SaladDay
SaladDay deleted the docs/final-manual branch October 7, 2026 06:38
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.

2 participants