[PR #2117] [MERGED] Update documentation for Apple #2509

Closed
opened 2025-12-29 03:21:35 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2117
Author: @nblock
Created: 9/9/2024
Status: Merged
Merged: 9/11/2024
Merged by: @kradalby

Base: mainHead: apple


📝 Commits (1)

  • 05d9419 Restructure documentation for Apple

📊 Changes

7 files changed (+112 additions, -130 deletions)

View changed files

📝 README.md (+9 -9)
docs/apple-client.md (+51 -0)
docs/iOS-client.md (+0 -30)
📝 docs/windows-client.md (+5 -5)
📝 hscontrol/templates/apple.html (+45 -84)
📝 integration/scenario_test.go (+1 -1)
📝 mkdocs.yml (+1 -1)

📄 Description

I tried hard not to modify the actual instructions as I don't have Apple devices that I could use to test it.

See the commit message for details.

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

Summary by CodeRabbit

  • Documentation
    • Updated the "Client OS support" section for improved clarity and navigation.
    • Enhanced the Apple client documentation to include both iOS and macOS, with reorganised headers for better structure.
    • Improved the Windows client documentation for better visibility of critical instructions.
    • Adjusted navigation structure to consolidate iOS and Apple documentation into a single entry.

🔄 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/2117 **Author:** [@nblock](https://github.com/nblock) **Created:** 9/9/2024 **Status:** ✅ Merged **Merged:** 9/11/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `apple` --- ### 📝 Commits (1) - [`05d9419`](https://github.com/juanfont/headscale/commit/05d9419f06fb9a4a3fbacde1a3c7bf7568adbe01) Restructure documentation for Apple ### 📊 Changes **7 files changed** (+112 additions, -130 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+9 -9) ➕ `docs/apple-client.md` (+51 -0) ➖ `docs/iOS-client.md` (+0 -30) 📝 `docs/windows-client.md` (+5 -5) 📝 `hscontrol/templates/apple.html` (+45 -84) 📝 `integration/scenario_test.go` (+1 -1) 📝 `mkdocs.yml` (+1 -1) </details> ### 📄 Description I tried hard not to modify the actual instructions as I don't have Apple devices that I could use to test it. See the commit message for details. - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [ ] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [ ] added integration tests - [x] updated documentation if needed - [ ] updated CHANGELOG.md <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated the "Client OS support" section for improved clarity and navigation. - Enhanced the Apple client documentation to include both iOS and macOS, with reorganised headers for better structure. - Improved the Windows client documentation for better visibility of critical instructions. - Adjusted navigation structure to consolidate iOS and Apple documentation into a single entry. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <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:21:35 +01:00
adam closed this issue 2025-12-29 03:21:35 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2509