docs: restructure README around reader personas#64
Merged
Conversation
- Replace the long persona deep-dives with a concise "What that means for you" section - De-bold the intro and lead with the open source AI linter framing - Trim the feature table and point to Features for the full list - Condense the "What it is not" section - Convert absolute shipyard.naftiko.io links to relative docs paths - Add a "Continue reading" section linking the core docs pages
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.
Related Issue
Closes #63
What does this PR do?
Restructures the Polychro
README.mdaround reader personas, mirroring the Ikanos README change (naftiko/ikanos#620) and based on the same user feedback: the README opened with dense, cross-domain jargon before the reader could tell whether the project was for them.Changes:
No feature claims are added or changed — this is purely a structure/onboarding improvement.
The companion docs changes (landing page + new
who-is-it-for.md) are in the Shipyard repo.Tests
No tests — documentation-only change. Verified Markdown renders cleanly and the referenced guide links resolve.
Checklist
mainAgent Context (optional)