Skip to content

Commit 35eab4a

Browse files
committed
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.
1 parent 74aae8a commit 35eab4a

File tree

3 files changed

+27
-5
lines changed

3 files changed

+27
-5
lines changed

.github/linters/.markdown-lint.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Configuration for markdownlint (used by Super Linter)
2+
3+
# MD041: README starts with HTML badges in this repo.
4+
MD041: false
5+
6+
# MD051: GitHub heading anchor generation can differ (emoji, punctuation).
7+
MD051: false
8+
9+
# MD013: The project documentation frequently contains long URLs/commands.
10+
MD013: false
11+
12+
# MD033: The main README uses inline HTML for badges.
13+
MD033: false
14+
15+
# Match existing list formatting in this repo.
16+
MD007:
17+
indent: 4
18+
19+
MD030:
20+
ul_single: 3
21+
ol_single: 2
22+
ul_multi: 3
23+
ol_multi: 2

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ PR will not be merged until all steps are complete.
2929

3030
If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.
3131

32-
- User docs: https://github.com/GameServerManagers/LinuxGSM-Docs
33-
- Dev docs: https://github.com/GameServerManagers/LinuxGSM-Dev-Docs
32+
- User docs: <https://github.com/GameServerManagers/LinuxGSM-Docs>
33+
- Dev docs: <https://github.com/GameServerManagers/LinuxGSM-Dev-Docs>
3434

3535
**Thank you for your Pull Request!**

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,8 @@ Notice how this doesn’t work for the other non-imperative forms:
154154

155155
Below is an example of the subject line for a pull request:
156156

157-
**feat(alerts): add slack support to alerts**
158-
159-
**fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround**
157+
- feat(alerts): add slack support to alerts
158+
- fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround
160159

161160
### Testing
162161

0 commit comments

Comments
 (0)