Skip to content

Conversation

@justinwilaby
Copy link
Contributor

@justinwilaby justinwilaby commented Jun 4, 2025

Add REPL and Prompt Command Documentation

Description

This PR adds comprehensive documentation for two interactive features of the Heroku CLI:

  1. The REPL (Read-Eval-Print Loop) functionality
  2. The interactive prompt functionality

The documentation provides clear guidance on how to use these features and their benefits.

Changes

  • Added docs/repl.md with:

    • Command usage and examples
    • Detailed description of REPL capabilities
    • Instructions for using and exiting the REPL
    • Link to source code
  • Added docs/prompt.md with:

    • Command usage and examples
    • Detailed description of interactive prompting features
    • Explanation of input validation and guidance
    • Link to source code
  • Added supporting command files:

    • src/commands/repl.ts - Guides users to use heroku --repl
    • src/commands/prompt.ts - Guides users to use heroku <COMMAND> --prompt

Why

These documentation additions:

  1. Make it easier for users to discover and use interactive features
  2. Provide clear guidance on the correct usage patterns
  3. Explain the benefits and capabilities of each feature
  4. Follow the existing documentation style and format

Testing

  • Verify documentation formatting matches other command docs
  • Check all links are correct
  • Verify examples are accurate and helpful
  • Test command help output matches documentation

@justinwilaby justinwilaby requested a review from a team as a code owner June 4, 2025 22:42
@justinwilaby justinwilaby force-pushed the feat/repl-prompt-docs branch from 63b0cfd to c1774ed Compare June 4, 2025 22:46
@justinwilaby justinwilaby force-pushed the feat/repl-prompt-docs branch from c1774ed to 45a76f3 Compare June 4, 2025 22:56
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
Signed-off-by: Sandy Lai <sandy.lai@salesforce.com>
@justinwilaby
Copy link
Contributor Author

Thank you @SandyPantsLai !

@justinwilaby justinwilaby enabled auto-merge (squash) June 11, 2025 16:49
Copy link
Contributor

@tlowrimore-heroku tlowrimore-heroku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, @justinwilaby! The only question I had has already been answered, that being: why --prompt rather than prompt.

@justinwilaby justinwilaby merged commit c52a129 into main Jun 19, 2025
8 checks passed
@justinwilaby justinwilaby deleted the feat/repl-prompt-docs branch June 19, 2025 20:30
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.

4 participants