skills/boshu2__agentops
1
0
Fork 0
mirror of https://github.com/boshu2/agentops.git synced 2026-09-14 15:08:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
v2.38.0
boshu2__agentops/mkdocs.yml
T
Claude c4166a5c51 docs: fix broken CLI links, add HOOKS/SCHEMAS/UPGRADING pages, expand GLOSSARY 
Addresses a batch of documentation improvements identified in a full-docs
audit. The goal is to reduce newcomer friction from dead links and missing
canonical references, and to give skill/plugin authors explicit pages for
hooks, schemas, and version migration that were previously implied only by
source code.

Navigation fixes:
- docs/INDEX.md and docs/newcomer-guide.md pointed to the wrong path for
  the CLI reference (cli/commands.md vs. the real cli/docs/COMMANDS.md).
  Replace with the canonical github URL so both mkdocs and raw-GitHub
  readers land on the file.
- INDEX.md Getting Started section now opens with a "pick your path"
  router so evaluators, installers, contributors, and upgraders don't
  have to triangulate across three overlapping entry points.
- Link docs/getting-started/index.md from INDEX.md (was previously
  orphaned) and add an "Install verification" block pointing at ao doctor.

New pages:
- docs/HOOKS.md: user-facing orientation covering lifecycle events,
  install/uninstall, customization env vars, and common failure modes,
  pointing to cli/docs/HOOKS.md for the deep technical reference.
- docs/SCHEMAS.md: catalog of every JSON Schema under schemas/ and
  lib/schemas/, grouped by manifest vs. runtime artifact vs. internal
  contract, with validation commands.
- docs/UPGRADING.md: action-required version migration guide. Seeds
  Unreleased (2.38.x) and 2.37.x sections covering strict delegation,
  --no-lifecycle -> --no-scaffold rename, Olympus bridge removal,
  swarm-evidence schema enforcement, and pre-mortem gate tightening.

Reference quality:
- GLOSSARY.md: 11 new terms (.agents/, MEMORY.md, Compact/PreCompact,
  Compile, Context Window, Discovery, Dream/Overnight Run alias,
  Flywheel Health, Harvest, Holdout, RPI Phase, Session Lifecycle).
- troubleshooting.md: three new failure-mode sections (pre-mortem gate,
  go-test-precommit block, context-window compaction recovery).
- CONTRIBUTING.md: escalates the sync-skill-counts.sh requirement from
  an easily-missed sentence to a bold callout with CI-failure rationale.

mkdocs.yml: registers the three new pages in nav so they're reachable
from the published site and pass strict build.

Validation:
- tests/docs/validate-links.sh: 1553 links checked, 0 broken.
- tests/docs/validate-doc-release.sh: PASS.
- scripts/docs-build.sh --check: new docs introduce 0 warnings (the
  single remaining preexisting warning about index.md is out of scope).
2026-04-22 05:01:02 +00:00

254 lines
8.2 KiB
YAML
Raw Permalink Blame History

site_name: AgentOps
site_description: The operational layer for coding agents. Memory, validation, and feedback loops that compound between sessions.
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
# 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
- Newcomer Guide: newcomer-guide.md
- Create Your First Skill: create-your-first-skill.md
- Behavioral Discipline: behavioral-discipline.md
- FAQ: FAQ.md
- Contributing: CONTRIBUTING.md
- Security: SECURITY.md
- Changelog: CHANGELOG.md
- Upgrading: UPGRADING.md
- Skills:
- skills/index.md
- Skills Reference: SKILLS.md
- Decision Tree: skills-decision-tree.md
- Skill API: SKILL-API.md
- Skill Router: SKILL-ROUTER.md
- Catalog: skills/catalog.md
- CLI:
- cli/index.md
- Command Reference: cli/commands.md
- CLI ↔ Skills Map: cli-skills-map.md
- Hooks Overview: HOOKS.md
- Hooks Reference: cli/hooks.md
- Architecture:
- architecture/index.md
- How It Works: how-it-works.md
- Architecture Overview: ARCHITECTURE.md
- Software Factory: software-factory.md
- Codex Hookless Lifecycle: architecture/codex-hookless-lifecycle.md
- Primitive Chains: architecture/primitive-chains.md
- PDC Framework: architecture/pdc-framework.md
- FAAFO Alignment: architecture/faafo-alignment.md
- Failure Patterns: architecture/failure-patterns.md
- AO Command Customization: architecture/ao-command-customization-matrix.md
- Workflows:
- workflows/README.md
- Complete Cycle: workflows/complete-cycle.md
- Session Lifecycle: workflows/session-lifecycle.md
- Quick Fix: workflows/quick-fix.md
- Debug Cycle: workflows/debug-cycle.md
- Knowledge Synthesis: workflows/knowledge-synthesis.md
- Assumption Validation: workflows/assumption-validation.md
- Post-Work Retro: workflows/post-work-retro.md
- Multi-Domain: workflows/multi-domain.md
- Continuous Improvement: workflows/continuous-improvement.md
- Infrastructure Deployment: workflows/infrastructure-deployment.md
- Meta-Observer: workflows/meta-observer-pattern.md
- Concepts:
- Philosophy: philosophy.md
- Knowledge Flywheel: knowledge-flywheel.md
- The Science: the-science.md
- Brownian Ratchet: brownian-ratchet.md
- Context Lifecycle: context-lifecycle.md
- Context Packet: context-packet.md
- Curation Pipeline: curation-pipeline.md
- Evolve Setup: evolve-setup.md
- Seed Definition: seed-definition.md
- Scale Without Swarms: scale-without-swarms.md
- Strategic Direction: strategic-direction.md
- Leverage Points: leverage-points.md
- Levels:
- levels/index.md
- L1 — Basics: levels/L1-basics/README.md
- L2 — Persistence: levels/L2-persistence/README.md
- L3 — State Management: levels/L3-state-management/README.md
- L4 — Parallelization: levels/L4-parallelization/README.md
- L5 — Orchestration: levels/L5-orchestration/README.md
- Comparisons:
- comparisons/README.md
- vs SDD: comparisons/vs-sdd.md
- vs GSD: comparisons/vs-gsd.md
- vs Superpowers: comparisons/vs-superpowers.md
- vs Claude-Flow: comparisons/vs-claude-flow.md
- vs Compound Engineer: comparisons/vs-compound-engineer.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
- Incident Runbook: INCIDENT-RUNBOOK.md
- Troubleshooting: troubleshooting.md
- Agent Footguns: agent-footguns.md
- AgentOps Brief: agentops-brief.md
- AgentOps System Map: agentops-system-map.md
- Reference Deep-Dive: reference.md
- Contracts:
- contracts/index.md
- Repo Execution Profile: contracts/repo-execution-profile.md
- Autodev Program: contracts/autodev-program.md
- RPI Run Registry: contracts/rpi-run-registry.md
- Next-Work Queue: contracts/next-work.schema.md
- Finding Registry: contracts/finding-registry.md
- Finding Compiler: contracts/finding-compiler.md
- Hook Runtime Contract: contracts/hook-runtime-contract.md
- Headless Invocation: contracts/headless-invocation-standards.md
- Codex Skill API: contracts/codex-skill-api.md
- Context Assembly Interface: contracts/context-assembly-interface.md
- Session Intelligence Trust Model: contracts/session-intelligence-trust-model.md
- Dream Run: contracts/dream-run-contract.md
- Dream Report: contracts/dream-report.md
- Swarm Evidence: contracts/swarm-evidence.md
- Scope Escape Report: contracts/scope-escape-report.md
- Dispatch Checklist: contracts/dispatch-checklist.md
Reference in New Issue View Git Blame Copy Permalink