Skip to content

docs: align engine documentation with current features - #104

Merged
ovasylenko merged 1 commit into
mainfrom
agent/update-engine-docs
Jul 27, 2026
Merged

docs: align engine documentation with current features#104
ovasylenko merged 1 commit into
mainfrom
agent/update-engine-docs

Conversation

@ovasylenko

Copy link
Copy Markdown
Contributor

What changed

  • expand the root feature overview to cover the implemented execution, worker, governance, AI, security, distribution, continuity, and operations capabilities
  • make docs/README.md a complete index of the repository's feature guides
  • align architecture documentation with node roles, gRPC sessions, governed push delivery, package distribution, and current CLI responsibilities
  • update the curated API guide for secure tenant defaults, principals, entitlements, effects, change feeds, remediation, and continuity controls
  • make the Docker example include the authentication and encryption configuration required by secure defaults

Why

Recent engine features were documented in focused guides and the changelog, but the primary README, architecture overview, API summary, and documentation index did not consistently expose them. This made implemented capabilities difficult to discover and left one Docker example inconsistent with startup requirements.

Impact

New users and operators can now discover the current feature set from the main entry points, while generated OpenAPI and the changelog remain the exhaustive sources of truth.

Validation

  • git diff --check
  • verified every relative Markdown link in the changed files resolves locally
  • verified every top-level docs/*.md guide is linked from docs/README.md

@ovasylenko
ovasylenko marked this pull request as ready for review July 27, 2026 03:28
@ovasylenko
ovasylenko merged commit 3ce4544 into main Jul 27, 2026
7 of 9 checks passed
@ovasylenko
ovasylenko deleted the agent/update-engine-docs branch July 27, 2026 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant