Skip to content

docs: clean up and trim main README into a concise overview#26

Merged
nah414 merged 1 commit into
mainfrom
readme-cleanup-2026-06-09
Jun 9, 2026
Merged

docs: clean up and trim main README into a concise overview#26
nah414 merged 1 commit into
mainfrom
readme-cleanup-2026-06-09

Conversation

@nah414

@nah414 nah414 commented Jun 9, 2026

Copy link
Copy Markdown
Owner

What

Cleans up and trims the main README.md so the GitHub landing page reads as a concise, professional overview rather than an exhaustive build log.

Changes

  • Restructured sections — split the dense intro into a definition paragraph + a "what it isn't" disclaimer, and moved the release narrative out of the Documents section so Documents lists only documents.
  • Collapsed the per-phase build log — replaced the long per-phase "Release history" prose and the 19-row per-phase Status table (every dev0dev12/rc1 version 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.
  • Trimmed the document descriptions to their essence.
  • Normalized dashes — converted the table's -- separators to em-dashes () for consistent rendering.

Preserved

No facts invented; this is a summarize-and-trim pass over existing content. Kept intact:

  • all document links (architecture spec, Phase 0 build guide, perception plans v0/v1),
  • the Apache 2.0 license section and its Decision 34 rationale,
  • the key facts: v1.0.0 released, v1.1 in progress, perception extension planned,
  • the author note.

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.8 breakdown, and the 1.0.0 vs 1.0.0rc1 content-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:

  • Rewrite the README introduction into a clearer definition of Phoenix plus a separate "what it isn’t" disclaimer.
  • Trim and simplify document descriptions while preserving links to the architecture spec, build guide, and perception harness plans.
  • Replace the detailed phase timeline and status table with a concise status section summarizing the current v1.0.0 release, v1.1 work in progress, and planned perception extension.

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>
@sourcery-ai

sourcery-ai Bot commented Jun 9, 2026

Copy link
Copy Markdown

Reviewer's Guide

Refactors 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

Change Details Files
Restructured the README introduction and separated the product definition from disclaimers about what Phoenix is not.
  • Split the original dense intro paragraph into a concise definition paragraph and a follow-up "not a SaaS / not a chat" clarification
  • Kept the core description of Phoenix’s purpose and positioning but improved readability and flow
  • Retained the v1.0 release statement while trimming extra narrative about Phase 13 and dev-version details
README.md
Simplified the Documents section to highlight key docs with shorter, higher-level descriptions.
  • Trimmed the architecture spec description to a high-level summary of what it covers while keeping the v1.1 revision note
  • Condensed the Phase 0 build guide description to emphasize the minimum skeleton and scaffolding
  • Promoted the perception harness plan into a clearly labeled future extension planning subsection, keeping the v0 plan as an historical record
README.md
Replaced the detailed per-phase release history and large status table with a concise Status section organized by current, in-progress, and planned work.
  • Removed the phase-by-phase shipping narrative, dev-version numbers, commit hashes, and granular implementation notes from the README
  • Introduced a ## Status section summarizing the current v1.0.0 release, high-level "what's live" components, and in-progress v1.1 cognition work
  • Added a brief summary of planned/deferred items (reference admin client and perception extension), pointing readers to the architecture doc for full acceptance criteria
README.md
Normalized wording and punctuation and tightened language for professionalism and readability.
  • Standardized dash usage by replacing -- table-style separators with em dashes for consistent rendering
  • Removed or rephrased overly detailed test counts and sub-phase breakdowns that belong in architecture/build docs or git history
  • Ensured all existing important links (docs, release, license) and key facts (v1.0 released, v1.1 in progress, perception extension planned) remain present
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • 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.
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`.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@nah414 nah414 merged commit c01b88c into main Jun 9, 2026
10 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant