From a34245f3fe6ad5130629a7e481e1482c0a5ec1cf Mon Sep 17 00:00:00 2001 From: Ali Muhammad Date: Sun, 19 Jul 2026 05:47:14 +0500 Subject: [PATCH] docs: add runnable guides and SEO checks --- CHANGELOG.md | 4 + overrides/main.html | 10 - scripts/check_docs.py | 35 + site_docs/concepts/index.md | 2 +- site_docs/contributing/adr-template.md | 2 +- site_docs/contributing/contract-tests.md | 2 +- site_docs/contributing/development.md | 2 +- site_docs/contributing/maintainers.md | 2 +- site_docs/contributing/releasing.md | 2 +- site_docs/guides/context-engineering.md | 68 +- site_docs/guides/cost-tracking.md | 63 +- site_docs/guides/durability-backends.md | 93 +- site_docs/guides/durability.md | 127 ++- site_docs/guides/evaluation.md | 81 ++ site_docs/guides/execution-identity.md | 107 ++- site_docs/guides/genai-telemetry.md | 97 +- site_docs/guides/handoff.md | 122 +++ site_docs/guides/hosting-services.md | 88 ++ site_docs/guides/human-in-the-loop.md | 74 +- site_docs/guides/index.md | 2 +- site_docs/guides/mcp.md | 102 ++- site_docs/guides/memory-and-rag.md | 96 +- site_docs/guides/multi-agent-team.md | 115 +++ site_docs/guides/observability.md | 93 +- site_docs/guides/plugins.md | 97 +- site_docs/guides/policy-routing.md | 97 +- site_docs/guides/portable-infrastructure.md | 164 +++- site_docs/guides/production-controls.md | 77 ++ site_docs/guides/production-readiness.md | 83 ++ site_docs/guides/providers.md | 74 ++ site_docs/guides/reasoning-models.md | 88 +- site_docs/guides/reflection.md | 80 +- site_docs/guides/routing.md | 86 ++ site_docs/guides/sandbox-providers.md | 180 +++- site_docs/guides/streaming.md | 89 +- site_docs/guides/structured-output.md | 67 ++ site_docs/guides/tools.md | 110 +++ site_docs/guides/verification-gates.md | 76 +- site_docs/guides/visualization.md | 127 +++ site_docs/guides/yaml-config.md | 69 ++ site_docs/index.md | 2 +- site_docs/reference/api-inventory.md | 2 +- site_docs/reference/built-in-tools.md | 2 +- site_docs/reference/cli.md | 66 +- site_docs/reference/configuration.md | 2 +- site_docs/reference/index.md | 2 +- site_docs/reference/public-api.md | 957 +++++++++++++++++++- site_docs/reference/runtime-contracts.md | 2 +- site_docs/reference/semantic-contracts.md | 2 +- site_docs/tutorials/code-review-crew.md | 2 +- site_docs/tutorials/research-assistant.md | 2 +- site_docs/typescript/index.md | 2 +- tests/test_check_docs.py | 23 +- tests/test_ci.py | 14 + 54 files changed, 3966 insertions(+), 67 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46afcbf..6452176 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- **Runnable, searchable documentation** - added complete copyable programs across core guides, expanded CLI and public API coverage, normalized page descriptions for search snippets, removed duplicate social metadata, and added regression checks for page structure and version-switcher deployment. + ## [0.8.0] - 2026-07-16 ### Added diff --git a/overrides/main.html b/overrides/main.html index 1a34d7b..c156066 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -16,16 +16,6 @@ {% if page and page.meta and page.meta.keywords %} {% endif %} - - - - - - - - - -