docs: align engine documentation with current features - #104
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
docs/README.mda complete index of the repository's feature guidesWhy
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 --checkdocs/*.mdguide is linked fromdocs/README.md