docs: Replace placeholder README with comprehensive API documentation#51
Open
docs: Replace placeholder README with comprehensive API documentation#51
Conversation
The README had 'TODO: Write usage instructions here' since the gem was created. Replace with full documentation covering: - Defining commands (include Command, option, execute) - Running commands (.run vs .run! with monadic results) - Declaring inputs (required, optional, defaults) - Type system (Types::String, Types.Instance, Types::Interface, etc.) - ActiveModel validations (before and during execute) - Composing commands (compose with error propagation) - Input middleware (ActionController::Parameters, symbolization) - API reference table (class methods, instance methods, result objects) - Complete end-to-end example with controller/job usage - RSpec helper with stubbing patterns All examples are derived from real usage patterns in the ue codebase. Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
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.
Summary
The README has had
TODO: Write usage instructions heresince the gem was created. This replaces it with comprehensive documentation derived from reading the gem source and studying real usage patterns across 1000+ commands in the ue codebase.What's documented
include Command,option,execute.run(monadic result) vs.run!(unwrap-or-raise)Types::usage (String,Integer,Bool,Instance,Interface,enum,Coercible,optional)errors.addcomposewith automatic error propagation viaCommand::InterruptActionController::Parametershandling, key symbolizationcreate_outcomefor stubbing in testsAll examples are derived from real patterns in production (e.g.,
OrganizationAdmin::FindOrCreateCompetitorsfor compose,Votes::Exceededfor typed options with defaults).