starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-11 20:00:28 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[PR #1575] [MERGED] Fix/improve documentation formatting #2188

New Issue
Closed
opened 2025-12-29 03:20:08 +01:00 by adam · 0 comments
adam commented 2025-12-29 03:20:08 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/1575
Author: @majabojarska
Created: 10/15/2023
Status: ✅ Merged
Merged: 3/22/2024
Merged by: @ohdearaugustin

Base: main ← Head: fix_docs_formatting

📝 Commits (2)

📊 Changes

6 files changed (+372 additions, -368 deletions)

View changed files

📝 .prettierignore (+5 -0)
📝 docs/dns-records.md (+17 -15)
📝 docs/running-headscale-container.md (+118 -121)
📝 docs/running-headscale-linux-manual.md (+107 -108)
📝 docs/running-headscale-linux.md (+24 -24)
📝 docs/running-headscale-openbsd.md (+101 -100)

📄 Description

Description

Fixes markdown formatting/indentation issues to properly render via mkdocs:

  • Enumeration. Several enumerated lists rendered improperly, as multiple "1." entries:
    image
  • Replace sequential enumeration (1. 2. 3. ...) with 1.-based enumeration. The renderer takes care of mapping the correct index to each list element. Generally easier to maintain.
  • Improves readability by using admonitions, e.g.:
    image
  • Improves consistency of monospace formatting for package/image names.

Validation steps

  1. Run mkdocs serve.
  2. Open the live preview.
  3. Inspect the rendered documents relevant to the PR's scope.
  • read the CONTRIBUTING guidelines
  • raised a GitHub issue or discussed it on the projects chat beforehand Not applicable
  • added unit tests Not applicable
  • added integration tests Not applicable
  • updated documentation if needed
  • updated CHANGELOG.md

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/juanfont/headscale/pull/1575 **Author:** [@majabojarska](https://github.com/majabojarska) **Created:** 10/15/2023 **Status:** ✅ Merged **Merged:** 3/22/2024 **Merged by:** [@ohdearaugustin](https://github.com/ohdearaugustin) **Base:** `main` ← **Head:** `fix_docs_formatting` --- ### 📝 Commits (2) - [`4079354`](https://github.com/juanfont/headscale/commit/407935486c9b5e3ba8cb6679dad73b2a8e78bfde) Fix docs formatting - [`3f70719`](https://github.com/juanfont/headscale/commit/3f70719e4547482409d44d3838d71cd52e069001) .prettierignore add docu ### 📊 Changes **6 files changed** (+372 additions, -368 deletions) <details> <summary>View changed files</summary> 📝 `.prettierignore` (+5 -0) 📝 `docs/dns-records.md` (+17 -15) 📝 `docs/running-headscale-container.md` (+118 -121) 📝 `docs/running-headscale-linux-manual.md` (+107 -108) 📝 `docs/running-headscale-linux.md` (+24 -24) 📝 `docs/running-headscale-openbsd.md` (+101 -100) </details> ### 📄 Description ## Description Fixes markdown formatting/indentation issues to properly render via mkdocs: - Enumeration. Several enumerated lists rendered improperly, as multiple "1." entries: ![image](https://github.com/juanfont/headscale/assets/33836570/99ffda85-9cc3-4fb5-9608-9be709a82ea8) - Replace sequential enumeration (`1. 2. 3. ...`) with `1.`-based enumeration. The renderer takes care of mapping the correct index to each list element. Generally easier to maintain. - Improves readability by using admonitions, e.g.: ![image](https://github.com/juanfont/headscale/assets/33836570/a69c4188-d162-4026-93b2-e69e476f2130) - Improves consistency of `monospace` formatting for package/image names. ## Validation steps 1. Run `mkdocs serve`. 2. Open the live preview. 3. Inspect the rendered documents relevant to the PR's scope. --- - [x] read the [CONTRIBUTING guidelines](README.md#contributing) - [ ] ~raised a GitHub issue or discussed it on the projects chat beforehand~ Not applicable - [ ] ~added unit tests~ Not applicable - [ ] ~added integration tests~ Not applicable - [x] updated documentation if needed - [ ] updated CHANGELOG.md --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 03:20:08 +01:00
adam closed this issue 2025-12-29 03:20:08 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2188
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?