From 0b40f5a790a4314fcb97e8dd3d27cf27d3a86424 Mon Sep 17 00:00:00 2001 From: teknium1 <127238744+teknium1@users.noreply.github.com> Date: Sun, 13 Sep 2026 05:46:05 -0700 Subject: [PATCH] docs: fold the root docs/ tree into the Docusaurus site and delete it docs/ was not the documentation site; it was a grab bag of long-form design notes, wire contracts and observability guides that landed with feature PRs because their authors needed somewhere to put them. Root AGENTS.md already says long-form dev docs live in website/docs/developer-guide/; this moves the 14 living documents there (or to the matching user-guide section) so they are published, searchable and linked from the sidebar instead of being found by grep only. Developer guide: micro-compaction, gateway-session-lifecycle (was session-lifecycle), state-db-recovery, multiplexing-gateway, chronos-managed-cron-contract, relay-connector-contract, observer-hooks (was observability/README), gateway-monitoring (observability/monitoring), relay-shared-metrics, middleware, streaming-tts, billing-lifecycle. User guide: egress/network-isolation (was security/network-egress- isolation), features/kanban-multi-gateway (was kanban/multi-gateway). Each page got title/description frontmatter and a sidebar entry; repo- relative links became site links or GitHub blob URLs; two MDX brace hazards escaped. Every in-tree pointer (module docstrings, config comments, the relay conformance test's Path, the monitoring-doc test, gateway-internals, cron-internals, kanban docs, .dockerignore, AGENTS.md) now names the new location. `docusaurus build` passes with no unresolved links on the moved pages. --- .dockerignore | 3 +-- AGENTS.md | 2 +- agent/secret_scope.py | 4 ++-- gateway/relay/__init__.py | 2 +- gateway/relay/descriptor.py | 2 +- gateway/relay/transport.py | 2 +- gateway/relay/ws_transport.py | 2 +- hermes_cli/config_defaults.py | 4 ++-- hermes_cli/subcommands/gateway.py | 2 +- hermes_state_common.py | 2 +- plugins/cron_providers/chronos/__init__.py | 2 +- plugins/cron_providers/chronos/_nas_client.py | 2 +- .../gateway/relay/test_contract_doc_conformance.py | 4 ++-- tests/gateway/relay/test_relay_follow_up.py | 2 +- tests/gateway/relay/test_relay_sheds_crypto.py | 2 +- tests/monitoring/test_cron_health_export.py | 4 ++-- .../docs/developer-guide}/billing-lifecycle.md | 5 +++++ .../chronos-managed-cron-contract.md | 5 +++++ website/docs/developer-guide/cron-internals.md | 2 +- website/docs/developer-guide/gateway-internals.md | 2 +- .../docs/developer-guide/gateway-monitoring.md | 5 +++++ .../developer-guide/gateway-session-lifecycle.md | 9 +++++++-- .../docs/developer-guide}/micro-compaction.md | 5 +++++ .../docs/developer-guide/middleware.md | 7 ++++++- .../docs/developer-guide}/multiplexing-gateway.md | 12 ++++++++---- .../docs/developer-guide/observer-hooks.md | 5 +++++ .../developer-guide}/relay-connector-contract.md | 10 +++++++--- .../docs/developer-guide}/relay-shared-metrics.md | 5 +++++ .../docs/developer-guide}/state-db-recovery.md | 5 +++++ .../docs/developer-guide}/streaming-tts.md | 5 +++++ .../docs/user-guide/egress/network-isolation.md | 14 ++++++++++---- .../user-guide/features/kanban-multi-gateway.md | 5 +++++ website/docs/user-guide/features/kanban.md | 2 +- .../current/user-guide/features/kanban.md | 2 +- website/sidebars.ts | 14 ++++++++++++++ 35 files changed, 121 insertions(+), 39 deletions(-) rename {docs => website/docs/developer-guide}/billing-lifecycle.md (99%) rename {docs => website/docs/developer-guide}/chronos-managed-cron-contract.md (98%) rename docs/observability/monitoring.md => website/docs/developer-guide/gateway-monitoring.md (99%) rename docs/session-lifecycle.md => website/docs/developer-guide/gateway-session-lifecycle.md (98%) rename {docs => website/docs/developer-guide}/micro-compaction.md (99%) rename docs/middleware/README.md => website/docs/developer-guide/middleware.md (97%) rename {docs/design => website/docs/developer-guide}/multiplexing-gateway.md (95%) rename docs/observability/README.md => website/docs/developer-guide/observer-hooks.md (98%) rename {docs => website/docs/developer-guide}/relay-connector-contract.md (99%) rename {docs/observability => website/docs/developer-guide}/relay-shared-metrics.md (99%) rename {docs => website/docs/developer-guide}/state-db-recovery.md (97%) rename {docs => website/docs/developer-guide}/streaming-tts.md (96%) rename docs/security/network-egress-isolation.md => website/docs/user-guide/egress/network-isolation.md (90%) rename docs/kanban/multi-gateway.md => website/docs/user-guide/features/kanban-multi-gateway.md (92%) diff --git a/.dockerignore b/.dockerignore index ae00a18bb9..f773f54263 100644 --- a/.dockerignore +++ b/.dockerignore @@ -80,9 +80,8 @@ apps/ # Test suite — not shipped in production images tests/ -# Documentation site (Docusaurus) and supplementary docs +# Documentation site (Docusaurus) website/ -docs/ # Assets only used by the GitHub README assets/ diff --git a/AGENTS.md b/AGENTS.md index 930a2afc19..fca7cee1d9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -252,7 +252,7 @@ families: `hermes_state.py` (21), `gateway/run.py` (15), `tools/mcp_tool.py` (15 (`_SLASH_DISPATCH` in `cli.py`, `_command_handler_table` in the gateway are the shape). - **No re-export shims for internal moves** ("keep the old name importable"). Internal paths are not API; external compat is handled ONCE by the compat layer, not per PR. -- **Moving a symbol means fixing its docs in the same PR:** grep `website/docs`, `docs/`, +- **Moving a symbol means fixing its docs in the same PR:** grep `website/docs`, `skills/`, and every `AGENTS.md` for the old `path.py` + symbol (23 doc files went stale after the refactor). `evals/codebase_navigability/static_metrics.py