diff --git a/.github/ISSUE_TEMPLATE/general-issue.md b/.github/ISSUE_TEMPLATE/general-issue.md deleted file mode 100644 index 8ed6bbb..0000000 --- a/.github/ISSUE_TEMPLATE/general-issue.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: General issue -about: A template for general issues -title: '' -labels: awaiting review -assignees: StrangeRanger - ---- - - diff --git a/README.md b/README.md index 98f73ef..144220c 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ You are encouraged to fork this repository for your own use and contribute to it - [Local Development](#local-development) - [Prerequisites](#prerequisites) - [Download and Setup](#download-and-setup) + - [Support and Community](#support-and-community) - [Acknowledgments](#acknowledgments) - [License](#license) @@ -33,8 +34,8 @@ You are encouraged to fork this repository for your own use and contribute to it To build and preview the documentation locally, you'll need: -- **Python** 3.9 or higher -- **[uv](https://github.com/astral-sh/uv#installation)** (a fast Python package manager and resolver) +- **Python**: Version 3.9 or higher +- **[uv](https://github.com/astral-sh/uv#installation)**: For dependency management ### Download and Setup @@ -57,6 +58,13 @@ To build and preview the documentation locally, you'll need: 4. **Open your browser:** Visit [http://localhost:8000](http://localhost:8000) to view the documentation with live reload. +## Support and Community + +Have a question, idea, or feedback about the guide? + +- Use [Discussions](https://github.com/StrangeRanger/bash-style-guide/discussions) to ask questions, propose new or revised guidelines, request clarifications, or share resources and examples. +- Use [Issues](https://github.com/StrangeRanger/bash-style-guide/issues) for actionable problems with the docs or site: broken links, incorrect examples, contradictions, build/deploy problems, or tracked maintenance tasks. + ## Acknowledgments - [bahamas10/bash-style-guide](https://github.com/bahamas10/bash-style-guide)