docs: synchronize documentation with codebase and fix drift - #124
Merged
Conversation
- Added missing `REST API` and `CLI Application` presets to the README.md - Removed deprecated `--python` flag from documentation examples and CLI epilog, as Python is now an implicitly loaded mandatory layer - Removed the deprecated "Generating Boilerplate" section and `generate` subcommand references from getting-started.md
JacksonFergusonDev
force-pushed
the
docs/syncronize-documentation
branch
from
July 31, 2026 05:43
c61b91a to
9eda0b7
Compare
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
1 participant
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.
Summary
This PR addresses documentation drift by synchronizing the
README.mdand Markdown documentation with the current state of the Protostar codebase. It removes deprecated flags and features, and ensures all available domain presets are properly listed.Key Changes
REST APIandCLI Applicationto the Domain Presets list in theREADME.mdto match the actual implemented presets.--pythonFlag: Python is now loaded as an implicit mandatory layer in Protostar's architecture. The legacy--pythonflag was removed from all CLI execution examples across the documentation and from the CLI help epilog incli.py.docs/getting-started.mdas theprotostar generatesubcommand is no longer present in the CLI parser.