OpenAgent Developer Manual (Offline Edition)
Implementation baseline: 2026-09-11
CLI baseline: oasn-sa-dev 0.7.3

How to read this package
========================

1. Keep the entire directory tree. Do not copy index.html by itself.
2. Double-click index.html and open it in Edge, Chrome, or another modern browser.
3. Use the language switch at the top of the same index.html to change between Chinese and English. There is no separate English index file.
4. Use the left navigation to switch chapters and the search box at the top to find commands, steps, and error codes.
5. “Print all” expands every chapter into a layout suitable for printing or saving as PDF.

If the page is blank or reports that the content bundle is missing
===================================================================

Confirm that these files remain at their original relative paths:

  index.html
  assets/content.js
  assets/app.js
  assets/styles.css
  assets/screenshots/*.png

Extract the complete package again and open index.html in place. Do not drag index.html out of this directory. The Chinese and English manuals share assets/content.js, so deleting or moving that file breaks both languages.

Package contents
================

- 19 developer chapters in Chinese and English covering creation, CLI, Workspace, Program, synchronization, models and integrations, testing, publication, Online state, and troubleshooting.
- 11 interface screenshots generated from the current website frontend and redacted E2E data.
- examples/minimal-summary-agent: a complete minimal Summary Agent walkthrough, including English companion files.
- content/*.html and content/en/*.html: maintainable chapter source files.
- content/manifest.json and content/manifest.en.json: matching route and navigation manifests.
- tools/build-docs.mjs and tools/validate-docs.mjs: deterministic build and offline validation scripts.

Offline boundary
================

The text, styles, scripts, screenshots, and examples can all be read offline. Network access is still required to sign in to the website, obtain the live Skill and CLI, create or connect to a Workspace, open WebChat, publish, and take an Agent Online.

The CLI file and its SHA-256 are intentionally not frozen into this package. Always use the download information bound to the current trusted prompt generated by “Build With Local Agent,” and verify that the installed CLI is oasn-sa-dev 0.7.3 or later before following Workspace or WebUI procedures.

Rebuild and validate for maintainers
====================================

From this directory, run with Node.js:

  node tools/build-docs.mjs
  node tools/validate-docs.mjs

The build reads both language manifests and source directories and regenerates assets/content.js. The validation command checks matching routes, content, screenshots, internal links, prohibited active content, and current CLI/WebUI documentation requirements. Edit source files and manifests rather than assets/content.js directly.

After both commands pass, open index.html through file://, switch between Chinese and English at the top, and inspect every chapter, navigation item, search result, screenshot, and print preview.
