docs(README): present the two distributions — appliance + Compose stack - #988
Merged
Conversation
…ible from the front page README never mentioned Pithead OS: the platform badge said Ubuntu 24.04, Quick Start was compose-only, and the docs table had no appliance row. A reader landing on the repo could not learn the v2 headline feature exists. - intro + badge now name both channels - a 'Two ways to run it' table sits ahead of Quick Start; Quick Start opens by routing appliance users to the image - docs table gains the appliance row, and Getting Started is labeled the DIY path - getting-started.md and hardware.md each carry a one-line pointer to the appliance path, so no entry doc strands an appliance reader Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- 'there is nothing to type at all' was false: the appliance flow types a token and a disk-name confirmation, and dd is a documented write method. Swapped for the appliance guide's own phrasing. - 'self-updating image' ran ahead of the build: no user-reachable OS update path exists yet (#976 holds that decision). The fallback claim is real and stays; self-updating goes. - hardware.md's new pointer asserted 'the same sizing applies' over a real figure drift between the two pages (100/140/~300 vs 120/170/350 GB) — reworded to route appliance readers without asserting equivalence. The figure reconciliation is a separate follow-up. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
From the 2026-08-14 repo audit: README on develop-v2 was byte-identical to develop — the v2 headline feature was invisible from the repo front page. A reader could not learn Pithead OS exists.
getting-started.mdandhardware.mdeach carry a one-line pointer to the appliance path, so no entry doc strands an appliance reader (the audit found zero appliance mentions in either).Deliberately not touched: screenshots/imagery (rides #479, blocked on the logo decision) and faq.md (no natural slot without restructuring it).
Doc-only.
make lint-docs-voiceandmake lint-mdpass. Ponytail-review: one optional 1-line shrink, declined for voice-match.🤖 Generated with Claude Code