mirror of
https://github.com/boshu2/agentops.git
synced 2026-09-14 15:08:13 +08:00
Bo
d043390a0a
Resolves every spellbreaking finding (the blocker + all 13 majors) from the 3.3.0 release-readiness audit ([docs/audits/release-readiness-3.3-2026-07-20.md](docs/audits/release-readiness-3.3-2026-07-20.md), included in this PR). ## Finding → fix map **CLI self-documentation (M1–M3)** - **M1** `ao robot-docs` prescribed removed `ao inject` → line removed from the canonical agent workflow; `inject` added to the removed-command hint table **and** the MIGRATION.md map (drift test `TestRemovedVerbsHaveMigrationRows` enforces the pair). - **M2** `ao config --help` documented ~14 env vars for removed subsystems (RPI/Dream/Council/tiers) → help text and the `--show` env panel pruned to the 5 vars the binary consumes; mirrored list in `internal/config` pruned identically. - **M3** `ao flywheel status` read only legacy `.agents/<section>` while `ao doctor fix` migrates learnings to canonical `.agents/ao/learnings` → new `quality.KnowledgeSectionDirs` dual-roots every knowledge reader (tier counts, new/stale artifacts, retros, health delta, utility, loop metrics, retrievable-citation stats — plus the golden-signals readers `ComputeResearchClosure`/`ComputeReuseConcentration` that the fresh verification pass caught as missed). Sandbox-proven twice: a learning existing only under `.agents/ao/learnings` appears in all metrics, and a research file only under `.agents/ao/research` flips closure from `starved/0` to `unmined/1 orphan`. **Release story (M4–M6)** - **M4** CHANGELOG `[3.3.0]` omitted post-07-17 surfaces → folded in `ao eval` (#921), default-build `ao flywheel`, the PreToolUse policy engine, and the #919 cleanup; date moved to 2026-07-20; `docs/CHANGELOG.md` re-synced (changelog.sync gate green). - **M5** MIGRATION.md attributed `ao eval` to a nonexistent "3.4" → now "returned in 3.3". - **M6** four release surfaces claimed a 50-skill corpus vs 48 everywhere real → all counts now 48 (CHANGELOG ×2, docs/3.3.md, release-notes page ×2). **Install story (M7 — product decision by Bo)** npx first (universal — installs into all coding agents), **plugins for Claude Code/Codex encouraged**, checkout + `ao skills link` as the source-tracked/contributor path; curl installers stay tombstones. Harmonized across README, UPGRADING, install-day2-ops, MIGRATION, 3.3.md, CHANGELOG, the release-notes page, all six installer tombstone messages (`install.sh` + claude/codex/agy/opencode/`codex.ps1`), and the site's CLI page. All "legacy migration-only / not the recommended path" plugin branding removed. **Docs site (B1, M8–M12)** - **B1** generated site CLI page instructed a tombstoned curl installer, nonexistent `ao rpi phased`, and wrong skills dir → `emit_index()` rewritten to the real install menu + a quickstart of commands that exist; semantic loop correctly attributed to skills. - **M8** deploy workflow's `--strict` contradicted mkdocs.yml's declared non-strict policy and aborted the build → flag dropped (lychee + validate-links.sh own link checking). - **M9** site banner said "AgentOps 2.x" → now 3.3. - **M10** ~176 internal files (audits/plans/handoffs/… + TEMP scratch doc) published and dominated search → `exclude_docs` extended; built site verified free of them; search index 4,751 → 2,444 entries. - **M11/M12** newcomer-guide skill links and all six SCHEMAS.md links 404'd on the site → absolute GitHub URLs (resolve on both GitHub and the site). The fresh verification pass found the same class on `docs/contracts/index.md` (nav-listed), `docs/contracts/corpus-learning-seam.md`, `docs/templates/slice-validation.md`, and five `docs/architecture/gas-city-factory.md` links into now-excluded `docs/audits/` — all repointed to absolute GitHub URLs. - Also from the verification pass: robot-docs exit-code table no longer says "bead claimed" (removed concept), and the docs.yml comment now cites the link checker that actually runs (`tests/docs/validate-links.sh` via doc-release checks) instead of lychee. **Skills corpus (M13)** - rch skill instructed 5 nonexistent scripts + 8 nonexistent reference files as recovery steps → pruned to the 7 real references; the wire-level `printf | rch` probe replaces the phantom `protocol_test.sh`; codex twin regenerated (parity gates green). ## Verification - `go vet` clean; **full test suite 60/60 packages pass** (includes the new-shape flywheel/quality/config tests and the inject↔MIGRATION drift test). - **`ao gate check --full --scope worktree`: 67/67 pass, 0 warnings** over this exact change set (changelog sync, shellcheck on the edited installer, skill mesh + codex parity, manifests/schema/triggers, provenance chain). - `scripts/regen-all.sh --check`: all generated projections current. - Rebuilt binary re-exercised: `robot-docs` clean, `ao inject` tombstone live, config help clean, flywheel sandbox proof above. - `mkdocs build` exit 0; warnings 84 → 46 (remainder is the accepted out-of-tree-link class per mkdocs.yml's declared policy). - Fresh-context adversarial verification workflow over all four fix groups (results in session log). ## Known residuals (deliberately out of scope) - `ao config models` subcommand still renders tier config (its two env vars ARE consumed; `COUNCIL_CLAUDE_MODEL` in its display list is not — follow-up). - Same-class single-rooted readers off the flywheel path: `learning.coherence` gate glob (`.agents/learnings/**` only), `quality.CountConstraints`, config `Paths` defaults feeding eval sandbox deny-lists. - `scripts/docs-build.sh` still uses `--strict` with its own allowlist (not wired into any workflow or gate). - Audit minors 1–8 (rc fallback version string, `config --show` legacy-fallback display, `ao init` vs doctor layout, doctor's `ao beads dir` hint, dead `tracker:` key in the example config, doc-skill phantom scripts, ROADMAP dead links, documentation-index root links).
206 lines
5.3 KiB
YAML
206 lines
5.3 KiB
YAML
site_name: AgentOps
|
|
site_description: One-pass intent, implementation, fresh validation, and durable evidence for coding agents.
|
|
site_url: https://boshu2.github.io/agentops/
|
|
site_author: AgentOps
|
|
|
|
repo_name: boshu2/agentops
|
|
repo_url: https://github.com/boshu2/agentops
|
|
edit_uri: edit/main/docs/
|
|
|
|
docs_dir: docs
|
|
site_dir: _site
|
|
|
|
# Internal working artifacts (audits, plans, handoffs, research, council logs,
|
|
# operationalized corpora, temp scratch docs) are repo artifacts, not website
|
|
# content — kept tracked in the repo but excluded from the published site so
|
|
# they never enter nav, search, or public URLs.
|
|
exclude_docs: |
|
|
audits/
|
|
brainstorms/
|
|
code-map/
|
|
constraints/
|
|
convergence/
|
|
council-log/
|
|
decisions/
|
|
evals/
|
|
evidence/
|
|
handoffs/
|
|
learnings/
|
|
migration-trackers/
|
|
plans/
|
|
rescope/
|
|
research/
|
|
sovereignty-proof/
|
|
TEMP-*.md
|
|
|
|
# Keep building even when the knowledge graph links outside docs/ (e.g., ../skills/).
|
|
# Strict link checking runs as a separate CI job via tests/docs/validate-links.sh + lychee.
|
|
strict: false
|
|
|
|
theme:
|
|
name: material
|
|
language: en
|
|
favicon: assets/favicon.svg
|
|
logo: assets/logo.svg
|
|
custom_dir: docs/overrides
|
|
palette:
|
|
# Dark mode default (slate) — toggle flips to light.
|
|
- media: "(prefers-color-scheme)"
|
|
scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to system preference
|
|
font:
|
|
text: Inter
|
|
code: Space Mono
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
edit: material/pencil
|
|
view: material/eye
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.indexes
|
|
- navigation.top
|
|
- navigation.footer
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.tracking
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.action.edit
|
|
- content.action.view
|
|
- content.tabs.link
|
|
- content.tooltips
|
|
- toc.follow
|
|
|
|
extra:
|
|
generator: false
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/boshu2/agentops
|
|
name: AgentOps on GitHub
|
|
|
|
extra_css:
|
|
- assets/stylesheets/extra.css
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
permalink_title: Anchor link
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
use_pygments: true
|
|
linenums: false
|
|
anchor_linenums: false
|
|
pygments_lang_class: true
|
|
guess_lang: false
|
|
auto_title: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets:
|
|
check_paths: true
|
|
base_path:
|
|
- docs
|
|
- .
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
plugins:
|
|
- search:
|
|
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
|
|
- gen-files:
|
|
scripts:
|
|
- docs/_hooks/gen_skill_pages.py
|
|
- docs/_hooks/gen_cli_reference.py
|
|
- section-index
|
|
- include-markdown
|
|
- git-revision-date-localized:
|
|
enable_creation_date: false
|
|
fallback_to_build_date: true
|
|
strict: false
|
|
type: date
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- getting-started/index.md
|
|
- "First-Value Path": first-value-path.md
|
|
- Newcomer Guide: newcomer-guide.md
|
|
- FAQ: FAQ.md
|
|
- Migration Guide: MIGRATION.md
|
|
- Skills:
|
|
- Skills Reference: SKILLS.md
|
|
- Skill Router: SKILL-ROUTER.md
|
|
- Skill Graph: reference/agentops-skill-graph.md
|
|
- CLI:
|
|
- Command Reference: cli/commands.md
|
|
- Architecture:
|
|
- architecture/index.md
|
|
- Operating Loop: architecture/operating-loop.md
|
|
- Go CLI Architecture: architecture/go-cli.md
|
|
- Gas City Factory: architecture/gas-city-factory.md
|
|
- How It Works: how-it-works.md
|
|
- Architecture Overview: ARCHITECTURE.md
|
|
- Component Map: architecture/component-map.md
|
|
- Ports and Adapters: architecture/ports-and-adapters.md
|
|
- Reference:
|
|
- reference/index.md
|
|
- Glossary: GLOSSARY.md
|
|
- Environment Variables: ENV-VARS.md
|
|
- Schemas: SCHEMAS.md
|
|
- Testing: TESTING.md
|
|
- CI/CD: CI-CD.md
|
|
- Releasing: RELEASING.md
|
|
- Contracts:
|
|
- contracts/index.md
|
|
- Codex Skill API: contracts/codex-skill-api.md
|
|
- Skill Ports: contracts/skill-ports-and-adapters.md
|
|
- Optional Dispatch: contracts/orchestration-ports.md
|
|
- Ubiquitous Language: contracts/ubiquitous-language.md
|