-
Notifications
You must be signed in to change notification settings - Fork 5
Implement Interactive Console Command for Step-by-Step Configuration Generation #14
Description
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:
-
Design Interactive Command:
- Design an interactive console command that prompts users for necessary information in a step-by-step manner.
- Utilize the
defaultConfiguration.yamltemplate to form the actual configuration.
-
Programming Language Handler Configuration:
- For configuring the programming language handler (currently only PHP), utilize the
phpHandlerDefaultSettings.yamltemplate to guide the user in setting up the language handler settings.
- For configuring the programming language handler (currently only PHP), utilize the
-
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.
-
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.
-
Create Pull Request:
- Once the interactive console command is implemented and tested locally, create a pull request to the
1.x.xbranch with your changes. - GitHub will automatically run any existing tests when you create the pull request.
- Once the interactive console command is implemented and tested locally, create a pull request to the
-
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.