docs(readme): rebuild as a lean showcase landing page#30
Merged
Conversation
Bring the README to the dotfiles-core exemplar bar: full reference-style shields header + logo + collapsible TOC, then a lean body — lead, three-layer at-a-glance, real Getting Started, an OS-native contribution contract, and License/Contact. Deep Alpine specifics (musl not glibc, doas not sudo, ash default, no MAC/flatpak, WSL OpenRC) now defer to the hub's per-repo page and the porting matrix. Add .markdownlint.jsonc (mirrored from dotfiles-core, OS-repo header) scoping the showcase HTML via MD033 allowed_elements. markdownlint-cli2: 0 errors. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XPiWr65kDzET4GSCAQz5A5
There was a problem hiding this comment.
Pull request overview
Rebuilds the repository README into a streamlined “showcase / landing page” aligned with the broader dotfiles fleet style, and adds a local markdownlint ruleset to support that HTML-heavy README layout.
Changes:
- Replaces the README with a centered shield/logo header, collapsible TOC, and lean “About / Getting Started / Layer contents / Contributing” sections that defer deep detail to the docs hub.
- Adds reference-style link definitions for badges and docs links at the end of the README.
- Introduces a
.markdownlint.jsoncconfiguration to allow specific HTML elements used by the README while keeping most markdownlint rules enabled.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Rebuilt into an exemplar-style landing page with shields, TOC, curated onboarding, and hub links. |
| .markdownlint.jsonc | Adds local markdownlint rule configuration (not CI-enforced) to support the new README structure. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <!-- Markdown Links & Images --> | ||
| [repo-docs]: https://dotgibson.github.io/dotfiles-web/docs/repos/dotfiles-Alpine | ||
| [porting]: https://dotgibson.github.io/dotfiles-web/docs/reference/porting-matrix | ||
| [dotgibson-shield]: https://img.shields.io/github/v/release/dotgibson/dotfiles-Alpine?style=flat-square&label=dotgibson&labelColor=181717&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAIAAAD8GO2jAAAF1klEQVR4nLSWbUxT7RnHr9PT09MXSltaoC9QXkqR16Iwhb0Iw8VYYE7jPri5aBaZzpmFZbpolpn4QeMyM%2BM%2B7MVt0Q9LNJIlxCzqxGWS6aKAig51vBQKIi3QltpCS0%2Fbc879pD1N3%2Bnz4fG5Pl2977v%2F331d131f5%2BZrddWQZAgAgy9uCRlefICzT6GeIsP%2FXF15kahmu9JglGmLRQoRQdIQWgu77BuWGe%2Fo%2BOqym8odApaWomTT1%2Bl2HqirahaTuJ9kQMggkgYhDRGfRiQDZBi9fuf52%2BD7l1b3ZhRcmq%2FMnBHmibuO7fvWoTalVoDjQRwL8RGgEOtzB0MbtBDnkRjGR0AgTK%2BQfNukr1LKXlhXKZpJSxTKGoFSq9vf16tQ8%2FiEh094Vu0L449mLGMup20DRWuFYVCiFm%2BvU36nTbOlMB%2BnCDxIOBzhvv6nFpc3TS0dUKDRHzh1Jk9O8wlPYN326Oa%2FJobnN8shAOxqKjrdXa8WSnGKWPewR%2FuHLG5P8oKUFJHi%2FH19F6UKEQ%2BnbJap27%2B%2BtWR15VAHgLkV%2F%2F0xW6OuQCfNE4PgmyX6f0xZKYbJDuj43lmtoYqHU%2FaZdwNXr4eoUG51zqgw%2B%2FCtrbm0UCeRynBhqVj2YC4RNC%2FuqStbKkydAODzeO7%2B6QYTpnOIYgB729R729RY9DAGafb0wDOHLwAA5vKK1mJNFoCpsxeLLn%2Fy91uU359719%2FfVXL%2BSM35IzU9rcXciCcQujz0imOfbGhOB0jkGo2hFQBW7Quzr0Zzq6vyBT%2FuKY%2BHErfBmQWLK1Lhr6l1OkleCqC0poPb%2FuTwv3OrA8DPDhgkokgLmLX77o86kqcGJmaj5xjr1JWlAAr1Js75MDEGAAI%2B1mvWX%2F1JY29XmYDPS5ZoNsrM24si1xSh3%2FRbGBYlz%2F73g41ztqliqYv1onyVHgDocMjjXASAKycavlqnZBHa2ajcasjv%2B8MbAPhRV9nI5MezB41crIPPHWOW9Gtl9XhDDCMCokIqSwGQ4shvyucFhEQCnqlSdm9k%2BdKt6XM%2FqO7aof7t8YbIIW5SHdpVIhUTAOAP0L8bmM3MHgJwByidQCgnhSmAqOEYnQ8AgRBr%2FuUzKsgggIs3pyVCfkeTCgAmFtaNOgm39C%2F3511r2W8JYvIAJbIaAwQ3vKAEoVgRaTQIBYKxqxgMs6euvdUXiQDgeHd5rV7K1fb2kC2rOgaYghQBMJ5grI3HUGuuhQiNIOWq8sy%2FLTgCKplgT0ZtCyprWw7%2FvKCyNr6yQqYg8cim59a9KQDnwv84R1%2F99UwAzsMya4vxeOYLN7YePGG%2BcAPjxXS%2BoavknFfOlRTAh8nHKNqLa1v2ZwK6dxQZtHk5ahu3%2FcYmLsoh%2B%2FsUgN%2BztDQzEvkYFBurGnan%2FS1%2B1P98L1FbxLIPzh193X%2FtwbmjiGUBYHd5nVFRCABPlxdtfh%2B3LHGKxof%2Bqo90C6yj58yi9Tm1kWjr94ZXsGhTuDuynAx2z0245yY4X06Kf9HWFd0N%2BuPbsUR64%2B3a57Erig2qIoOIlJSUNE69GWTZRFufXvRNL%2Fo2ywyJE1fMP6xWqHBEP5yfvP7%2FbAAAsFufG01mkVCqkGvLyrbNTD2mw9kfDckmE0oudx9rUZfhiF5Zd%2F%2F00QDF0NkBTJhanB3e0riHJIRKhXarqWfdu%2Bx0WnOot1ftuNR90lhQzEO0L7B2YvCm3b%2BWNI%2ByffSLq757%2BPcquYaIvBtgdcXycuzO9MzTFdccd9IwDNMVlDaXbzPXtxsVhQRDEQzl8i6d%2Buf12Y%2BONDVMo6vOfHWJxHLz3l811u8WAEZABCNAAHSI8n8k2HABKRJjLJ8JECxFMAE%2BHXhiGb7yn35vcCNDKVsEcSuv%2BEpn%2B7Etla0CwAQIOBLBhrkt85kAnwm8mX95e%2FTOa9vUZiIxQI43r0Kura9uN5SYNMoyuVDGZ2nK73C65iy28Rezo44152bSKYAvz3ifVA1lDn0WAAD%2F%2F%2FWvXexgMwqgAAAAAElFTkSuQmCC |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Brings the Alpine README up to the dotfiles-core exemplar bar as part of the fleet-wide standardization. Deep content it used to carry inline now lives on the docs hub (shipped in dotfiles-web#56), so this README is a lean public landing page that hands off cleanly.
Changes
dotfiles-Alpine; the CI badge trackslint.yml.core/) noting Alpine is the outlier of the set, the three-layer at-a-glance table, a real Getting Started (enablecommunity, run as root/doas, clone →bootstrap.sh), a What's In This Layer orientation, an OS-native contribution contract (don't fight the musl grain), and License/Contact.doasvs sudo,ashdefault, no MAC/flatpak, WSL OpenRC now link to the Alpine hub page and the porting matrix..markdownlint.jsoncmirrored from dotfiles-core (OS-repo header) scoping the showcase HTML via MD033allowed_elements.Verification
markdownlint-cli2 README.md→ 0 errors (including reference-link resolution).🤖 Generated with Claude Code
https://claude.ai/code/session_01XPiWr65kDzET4GSCAQz5A5
Generated by Claude Code