[PR #235] [MERGED] README / troubleshooting docs improvements #736

Closed
opened 2025-12-29 01:24:56 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/sickcodes/Docker-OSX/pull/235
Author: @kaoudis
Created: 4/5/2021
Status: Merged
Merged: 4/8/2021
Merged by: @sickcodes

Base: masterHead: master


📝 Commits (5)

  • cb6c0e5 link to KVM docs from GTK error
  • 42b52e2 move things around for flow and fix up links
  • e9ec998 couple minor formatting corrections
  • ee587a6 adds some of the more recent notable closed question issues
  • 6e50ac1 at least the important-ish links work now

📊 Changes

1 file changed (+517 additions, -457 deletions)

View changed files

📝 README.md (+517 -457)

📄 Description

Hi there! I wanted to clean up the base docs a bit based on my experience getting started with Docker-OSX.

What's changed

  • added some links to various closed issues
  • fixed dead links
  • unified internal link formatting (#the-section-name allows links to work locally and in forks, not just in this repo)
  • moved around sections for flow and resized some headings

If this is a lot, feel free to request changes or modify yourself, otherwise I can split this into multiple PRs by commit 🙂


🔄 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/sickcodes/Docker-OSX/pull/235 **Author:** [@kaoudis](https://github.com/kaoudis) **Created:** 4/5/2021 **Status:** ✅ Merged **Merged:** 4/8/2021 **Merged by:** [@sickcodes](https://github.com/sickcodes) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (5) - [`cb6c0e5`](https://github.com/sickcodes/Docker-OSX/commit/cb6c0e554b1714f07e66a859f7d78fa5728b352d) link to KVM docs from GTK error - [`42b52e2`](https://github.com/sickcodes/Docker-OSX/commit/42b52e2cc3ec0b068d049d2dd813c822e664b313) move things around for flow and fix up links - [`e9ec998`](https://github.com/sickcodes/Docker-OSX/commit/e9ec998332f9bed4df554af3d2e9222f313156ce) couple minor formatting corrections - [`ee587a6`](https://github.com/sickcodes/Docker-OSX/commit/ee587a69634131fa82f575f0637656c5e2e70121) adds some of the more recent notable closed question issues - [`6e50ac1`](https://github.com/sickcodes/Docker-OSX/commit/6e50ac14ee5ac9a040ff39effcccc1fe1831a76b) at least the important-ish links work now ### 📊 Changes **1 file changed** (+517 additions, -457 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+517 -457) </details> ### 📄 Description Hi there! I wanted to clean up the base docs a bit based on my experience getting started with Docker-OSX. What's changed - added some links to various closed issues - fixed dead links - unified internal link formatting (#the-section-name allows links to work locally and in forks, not just in this repo) - moved around sections for flow and resized some headings If this is a lot, feel free to request changes or modify yourself, otherwise I can split this into multiple PRs by commit :slightly_smiling_face: --- <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 01:24:56 +01:00
adam closed this issue 2025-12-29 01:24:56 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/Docker-OSX#736