Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Interactive Console Command for Step-by-Step Configuration Generation #14

Open
shcherbanich opened this issue Oct 3, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@shcherbanich
Copy link
Contributor

shcherbanich commented Oct 3, 2023

Context:
Creating a configuration file (bumble_doc_gen.yaml) is the preliminary step for users to generate project documentation. However, this task can be daunting for some. By observing the demo or the self-documentation recreation process, one can grasp how it operates. To simplify this task, we aim to introduce an interactive console command.

Objective:
The goal is to implement an interactive console command under the namespace BumbleDocGen\Console\Command that will guide users through the process of filling out the project configuration file step by step.

Implementation Steps:

  1. Design Interactive Command:

    • Design an interactive console command that prompts users for necessary information in a step-by-step manner.
    • Utilize the defaultConfiguration.yaml template to form the actual configuration.
  2. Programming Language Handler Configuration:

    • For configuring the programming language handler (currently only PHP), utilize the phpHandlerDefaultSettings.yaml template to guide the user in setting up the language handler settings.
  3. User Feedback:

    • Provide clear instructions and feedback to the user during each step of the interactive command.
    • Ensure any errors or warnings are communicated clearly to the user to prevent confusion.
  4. Test Locally:

    • Run the new console command locally to ensure it operates as expected, guiding the user through the configuration creation process without any hitches.
  5. Create Pull Request:

    • Once the interactive console command is implemented and tested locally, create a pull request to the 1.x.x branch with your changes.
    • GitHub will automatically run any existing tests when you create the pull request.
  6. Need Help?

    • If there are any issues or further clarifications needed, feel free to comment on the issue, and a maintainer will assist you.

This enhancement aims to simplify the initial setup process for users, making it easier to get started with generating project documentation using BumbleDocGen.

@shcherbanich shcherbanich added enhancement New feature or request good first issue Good for newcomers hacktoberfest labels Oct 3, 2023
@seanmcn seanmcn changed the title Add a console command to generate a basic project configuration Implement Interactive Console Command for Step-by-Step Configuration Generation Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants