docs: clean up and trim main README into a concise overview#26
Merged
Conversation
Restructure the README and replace the exhaustive per-phase build log with a concise "what's live" overview, while preserving all document links, the license, and the key facts (v1.0.0 released, v1.1 in progress, perception extension planned). - Split the dense intro paragraph into definition + disclaimer. - Move release narrative out of the Documents section into Status. - Collapse the per-phase Release history prose and the 19-row per-phase Status table into a current-version line plus a high-level "what's live" / "in progress" / "planned-deferred" summary. - Trim the document descriptions to their essence. - Normalize "--" separators to em-dashes for consistent rendering. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Reviewer's GuideRefactors the main README into a concise product overview by restructuring the intro and documents sections, replacing the detailed phase-by-phase build log and status table with a short status summary, tightening document descriptions, and normalizing punctuation while preserving core release facts and links. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The new
## Statussection is much clearer, but it still mixes time-specific facts (exact dates, provider SDK names, artifact details) with high-level positioning; consider moving some of the time-bound or low-level implementation details into the architecture/build docs and keeping this section focused on what a new reader needs to know in one screen. - The perception harness bullets under Documents and Status still read slightly heavier than the rest of the trimmed README; you might simplify those summaries to one short sentence each that defers deeper rationale and phase numbering to
PHOENIX_PERCEPTION_HARNESS_PLAN_v1.md.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new `## Status` section is much clearer, but it still mixes time-specific facts (exact dates, provider SDK names, artifact details) with high-level positioning; consider moving some of the time-bound or low-level implementation details into the architecture/build docs and keeping this section focused on what a new reader needs to know in one screen.
- The perception harness bullets under Documents and Status still read slightly heavier than the rest of the trimmed README; you might simplify those summaries to one short sentence each that defers deeper rationale and phase numbering to `PHOENIX_PERCEPTION_HARNESS_PLAN_v1.md`.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
nah414
added a commit
that referenced
this pull request
Jun 9, 2026
* @ docs(agents): add CLAUDE.md auto-loaded agent operating rules Encode the maintainer's working rules so every Claude Code session in this repo picks them up automatically (CLAUDE.md auto-loads per-repo). - CLAUDE.md (root): concise rule set, points to the detailed doc. - docs/AGENT_WORKFLOW.md: long-form rules, halt list, branch/commit conventions, reporting format, Windows/PowerShell notes, rationale. - docs/README.md: link the new workflow doc from the docs hub. Rules optimize for remote phone-driven sessions via Dispatch: no interactive pickers (plain-text questions only), autonomous reversible defaults, halt only for destructive/irreversible actions, feature branch only, plan-but-do-not-block, test before handing back. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> @ * @ docs(agents): forbid skipping git hooks / signing as a top-level rule Add an explicit short-form rule (new rule 5) in CLAUDE.md: never use --no-verify, never disable/skip/bypass pre-commit or commit-msg hooks or commit signing unless the maintainer explicitly asks; fix the underlying issue instead. Mirrors and strengthens AGENT_WORKFLOW.md section 4. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> @ * @ docs(agents): post-reorg path fixes + PR-consolidation rule Rebased onto current main (post #26/#27 docs reorg). Adjust for the new docs/ tree and capture the maintainer's PR-cadence preference. - CLAUDE.md: repoint build-guide reference from the old repo-root BUILDGUIDE_*.md files to docs/build-guides/ (moved by #27). - docs/README.md: re-add the AGENT_WORKFLOW.md pointer into the reorganized "Internal development records" section (the old pre-reorg edit was dropped during rebase). - CLAUDE.md + AGENT_WORKFLOW.md: add a new rule (short form rule 5; detail in AGENT_WORKFLOW.md section 4) — consolidate work, at most one PR per work-session/batch, branches may accumulate commits and sit for days, never open a PR proactively, default posture is keep-on-branch. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> @ * @ docs(agents): record mobile-Dispatch working method + 2026-06-09 session log Note in CLAUDE.md (not the README) that this repo is primarily driven via mobile Dispatch (Adam running Claude Code sessions from his phone while the desktop runs), and log today's session: README trim (#26 merged), docs/ reorg (#27 merged), auto-capture wiring (phase-13.x.9, parked), these agent rules, and the Step 5c cognition training/eval harness (parked; lightgbm 4.6.0 kept for local runs). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> @ --------- Co-authored-by: Claude Opus 4.8 (1M context) <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
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
Cleans up and trims the main
README.mdso the GitHub landing page reads as a concise, professional overview rather than an exhaustive build log.Changes
dev0–dev12/rc1version and granular implementation note) with a concise## Status: a current-version line, a high-level "what's live" overview, and short "in progress" / "planned-deferred" lines.--separators to em-dashes (—) for consistent rendering.Preserved
No facts invented; this is a summarize-and-trim pass over existing content. Kept intact:
Note for reviewers
Some granular facts were intentionally dropped from the README (still available in the linked architecture doc and git history): exact dev-version numbers, commit hashes, individual PR links, precise test counts, the Phase 13.x
.x.1–.x.8breakdown, and the1.0.0vs1.0.0rc1content-equivalence note. That trade-off is the point of "summary, not build log" — flagging in case any should be restored.🤖 Generated with Claude Code
Summary by Sourcery
Condense and restructure the main README into a concise, user-facing overview of Phoenix, its key documents, and current status, replacing the detailed phase-by-phase build log and release history with a high-level status summary.
Documentation: