docs: one story, honest maturity, and the site chrome - #581
Merged
Conversation
phux-ze33. The docs already had structure; they did not have one story. Cut restated product essays, put "what is phux" back in CONCEPTS, and make the maturity line match this tree: Cockpit ships, AgentSession is served, hub-and-spoke federation is real. Product pages are jobs again, not archives. tui.md 3206 to 607, agents.md 2318 to 673, mcp.md 745 to 218. Spec README is a two-minute model; the tutorial HELLO is 0.9. Architecture Status tables no longer claim the AgentSession engine is tests-only. Generated docs/reference/ is untouched.
Unsplit tui.md and agents.md so the site is not slicing numbered H2s that no longer exist. Publish the architecture diagram, add Cockpit to the consumer nav, and retarget primers to the new page jobs. Docs body uses the UI sans for reading; chrome stays the instrument stack. Landing nav wraps on a phone. Old /consumers/tui/commands and /consumers/agents/cli URLs redirect to the parent pages.
Public copy states what ships and links CONCEPTS for gaps. It does not introduce the product as pre-alpha on every page. The site footer and crate authors said Phil Hall. That is not the name. Copyright stays phall / no-phux.
Co-authored-by: Codesmith <codesmith-bot@users.noreply.github.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.
What
A full pass over the public docs and the docs site chrome so a high-bar reader can trust both the words and the page they are on.
The 3-layer doc system stays. What was broken was the story (four overlapping "what is phux" essays), a maturity line that disagreed with the code, product pages that were architecture dumps, and a site that still sliced
tui.md/agents.mdby numbered H2s those files no longer have.Why
Cockpit ships. This tree serves AgentSession (
RESOURCE_KINDS). Hub-and-spoke federation is real. The GitHub README, CONCEPTS, when-to-use, and phux.sh all said different things about those three facts. The site primers still pointed at/consumers/tui/commandsand/consumers/agents/cli.How
tui.md3206→607,agents.md2318→673,mcp.md745→218.docs/consumers/cockpit.md.Generated
docs/reference/is untouched.Validation
just docs-check— 193 files, 0 violationsbun run sync-docs— 167 pagesastro dev:/,/docs,/quickstart,/concepts,/consumers/tui,/consumers/agents,/consumers/cockpit,/wire,/architecture/diagramall 200; old slice URLs 308 to the parent page; desktop + 390px screenshots of landing and docs indexFollow-up
phux-ze33.8— compiledphux --skilltext still says AgentSession is on the resource-model branch.Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is enabled.