Commit Graph

11 Commits

Author SHA1 Message Date
asensagent a42d58d92b docs: comprehensive audit fix for CLI 1.0.0–1.4.2 (#520)
* docs: comprehensive audit fix for CLI 1.0.0–1.4.2

Align docs/ and skills/ with CLI actual state after 1.0.0→1.4.2 changes.

P0 — broken examples fixed:
- quickstart.mdx: add --session/--tab, use start+goto instead of open
- index.mdx: replace search→get→operate flow with start→snapshot→automate
- api-reference/cli.mdx: remove search/get sections, add full browser
  command reference with --session/--tab on all commands
- guides/browser.mdx: add --session/--tab to Local Mode examples,
  replace search→get recommended workflow with snapshot-based workflow
- guides/cli-and-skills.mdx: add --session/--tab, update skill workflow
  from search→get→operate to start→snapshot→automate

P1 — missing flags and commands:
- command-reference.md: add --provider/-p, --stealth/--no-stealth,
  --header, --session to start; add --wait-until to goto; add --by-ref
  to select; add --no-isolate, pre-context fields, structured error
  details to eval; add --screenshot-format, --selector to screenshot;
  add hermes target and --browser to setup; remove --executable-path
- SKILL.md: add missing commands to Observation row (viewport, attr,
  attrs, box, styles, describe, state, inspect-point, pdf) and
  Interaction row (focus, drag, upload, eval, mouse-move,
  cursor-position); add cloud provider workflow section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: restore search/get references per review feedback

Keep actionbook search and actionbook get sections in docs — they will
be adjusted later. Restores search/get to api-reference/cli.mdx,
index.mdx, browser.mdx recommended workflow, and cli-and-skills.mdx
core commands and skill workflow. The --session/--tab fixes on browser
commands remain.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: add select diagnostic output to command-reference

Document that `browser select` now returns structured diagnostics
(available values, visible texts, match mode, total count) when an
option is not found (PR #521).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-14 15:18:28 +08:00
sen df22a1ec40 docs: remove deprecated actionbook app documentation (#515)
[docs]chore: remove deprecated actionbook app documentation

The `actionbook app` (Electron desktop automation) feature was removed
during the CLI rewrite from TypeScript to Rust (v1.0.0+). The MDX
documentation was never cleaned up, causing users to encounter
"unknown command" errors when following the docs.

Removed:
- docs/guides/app-use.mdx (entire file)
- actionbook app section from docs/api-reference/cli.mdx
- Navigation entry from docs/docs.json
2026-04-13 20:39:56 +08:00
sen 94c7e2bea7 docs: update browser automation guide with cloud providers and CLI alignment (#514)
* [docs]docs: add cloud provider documentation for browser automation

- Add Cloud mode to Modes table and new Cloud Providers section in browser.mdx
- Add browser start/restart commands and expanded global flags in cli.mdx
- Add cloud provider tip in installation.mdx

* [docs]fix: align browser.mdx commands with actual CLI implementation

- Rename mode: Isolated → Local (matches Mode::Local enum)
- Fix command names: tab list → list-tabs, session list → list-sessions,
  wait-nav → wait navigation, wait-idle → wait network-idle,
  wait-fn → wait condition, hotkey → press, console → logs console,
  inspect → inspect-point, storage → local-storage/session-storage
- Remove 7 non-existent commands: fetch, batch, switch-frame, emulate,
  fingerprint, connect, info
- Fix argument order: fill/type use [selector] value (selector first)
- Fix coordinate format: mouse-move/inspect-point use comma x,y
- Fix flag: --full-page → --full for screenshot
- Fix cookies: session-level only (no --tab flag)
- Remove non-existent --ref and --human flags
- Remove non-existent -S short flag (use --session)
- Add --session/--tab to all per-tab command examples
- Restructure: add Session Lifecycle and Wait Conditions sections

All 47 documented commands verified against actionbook v1.4.1.

* [docs]refactor: reorder sections, remove stale content, polish wording

- Reorder: Local Mode → Cloud Providers → Extension Mode (by stability)
- Add "under active development" note on Extension mode
- Remove deprecated upgrade tip (v0.2.0 migration)
- Remove extension serve/stop mention
- Remove Risk Levels section (internal implementation detail)
- Simplify Extension Security to single paragraph
- Replace all em dashes with natural punctuation
- Simplify Session Lifecycle examples

* [docs]fix: remove unsupported -S shorthand from cli.mdx global flags

Address PR review comment: CLI only supports --session (long form),
no -S short alias exists.
2026-04-13 20:12:01 +08:00
mcfn.feng bd8c9767e7 [root]docs: restore deleted evaluate-api.mdx
Restores docs/api-reference/evaluate-api.mdx that was accidentally
removed in revert commit 72aac42.
2026-04-03 08:35:02 +08:00
AlexZ a35ba49827 [docs]fix: address PR #199 Codex review — correct CLI flags and arguments
- P2-1: `app attach [port]` → `app attach <target>` (required argument)
- P2-2: `--port` → `--cdp` (correct global flag for CDP port)
- P2-3: Remove invalid custom-path launch fallback; show manual
  start + attach workflow instead

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-13 18:35:51 +08:00
AlexZ 3299a0c5db [docs]feat: add actionbook app command documentation
- Add CLI reference for `actionbook app` commands (launch, attach, list, etc.)
- Add app automation guide with Electron use cases
- Update docs.json navigation structure
- Add agent prompt files to .gitignore

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-13 14:35:42 +08:00
sen c70683da86 [docs]docs: simplify browser workflow and make setup-first quickstart (#147) 2026-02-19 00:50:14 +08:00
Adcent 1aaa6548e8 docs: make website CLI-first and demote MCP/SDK paths (#119) 2026-02-12 10:43:34 +08:00
sen 2e47ee6dab Add browser extension and CLI reference documentation (#95)
* [docs]feat: add browser extension documentation for PR #89

Add comprehensive documentation for the Chrome Extension Bridge feature:
- New guides/browser-extension.mdx with setup, usage, security, and
  troubleshooting sections
- docs.json navigation updated with new page entry
- index.mdx gains Integration Options card section (CLI/Extension/MCP)
- installation.mdx table and links include extension method
- cli-and-skills.mdx adds extension mode tip after browser examples
- api-reference/cli.mdx adds extension subcommands and --extension
  global flag documentation

* [docs]fix: update extension docs to reflect GitHub Release install flow

Sync documentation with PR #93 changes: extension is now downloaded
from GitHub Releases instead of extracted from embedded CLI binary.
2026-02-09 18:42:47 +08:00
Adcent 9c5db26e1a docs: restructure documentation for CLI-first approach 2026-02-05 17:01:11 +08:00
Adcent e29ee02281 [docs]feat: add Mintlify documentation site
- Add introduction page with demo video, Why Actionbook section, and How It Works steps
- Configure Mintlify theme with black/white color scheme
- Add Actionbook logo (light/dark variants)
- Set up navigation structure with Documentation and API Reference tabs

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-16 21:23:06 +08:00