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

Add Table of CLI Flags, Environment Variables, and Descriptions to Getting Started Guide #3023

Closed
mastercactapus opened this issue May 15, 2023 · 0 comments · Fixed by #3048
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mastercactapus
Copy link
Member

What problem would you like to solve? Please describe:
Currently, the Getting Started guide for GoAlert does not include a comprehensive table that lists all the command line flags, corresponding environment variables, and descriptions for the project.

Describe the solution you'd like:
I propose adding a table to the Getting Started guide, which includes:

  1. All available command line flags
  2. Corresponding environment variables for each flag
  3. Clear and concise descriptions for each flag and variable

This table will make it easier for new users to understand and utilize GoAlert's configurable options and help new users get started quickly and efficiently.

Additional context:
This feature request aims to improve the documentation and user experience for new users of the GoAlert project.

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants