Browse Source

Improves documentation and linting

Updates documentation links to be enclosed in angle brackets, preventing markdown rendering issues.

Configures markdownlint to align with repository standards and avoid common false positives.

The updated links in the documentation ensure they are correctly interpreted by markdown parsers, improving user experience.

The markdownlint configuration fine-tunes linting rules to better match the project's existing style and conventions, reducing noise from irrelevant warnings.
pull/4854/head
Daniel Gibbs 4 months ago
parent
commit
35eab4aa76
Failed to extract signature
  1. 23
      .github/linters/.markdown-lint.yml
  2. 4
      .github/pull_request_template.md
  3. 5
      CONTRIBUTING.md

23
.github/linters/.markdown-lint.yml

@ -0,0 +1,23 @@
# Configuration for markdownlint (used by Super Linter)
# MD041: README starts with HTML badges in this repo.
MD041: false
# MD051: GitHub heading anchor generation can differ (emoji, punctuation).
MD051: false
# MD013: The project documentation frequently contains long URLs/commands.
MD013: false
# MD033: The main README uses inline HTML for badges.
MD033: false
# Match existing list formatting in this repo.
MD007:
indent: 4
MD030:
ul_single: 3
ol_single: 2
ul_multi: 3
ol_multi: 2

4
.github/pull_request_template.md

@ -29,7 +29,7 @@ PR will not be merged until all steps are complete.
If documentation does need updating either update it by creating a PR (preferred) or request a documentation update. If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.
- User docs: https://github.com/GameServerManagers/LinuxGSM-Docs - User docs: <https://github.com/GameServerManagers/LinuxGSM-Docs>
- Dev docs: https://github.com/GameServerManagers/LinuxGSM-Dev-Docs - Dev docs: <https://github.com/GameServerManagers/LinuxGSM-Dev-Docs>
**Thank you for your Pull Request!** **Thank you for your Pull Request!**

5
CONTRIBUTING.md

@ -154,9 +154,8 @@ Notice how this doesn’t work for the other non-imperative forms:
Below is an example of the subject line for a pull request: Below is an example of the subject line for a pull request:
**feat(alerts): add slack support to alerts** - feat(alerts): add slack support to alerts
- fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround
**fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround**
### Testing ### Testing

Loading…
Cancel
Save