Skip to content

docs: improve README visual hierarchy - #95

Merged
Coding-Dev-Tools merged 1 commit into
mainfrom
codex/readme-visual-hierarchy
Jul 30, 2026
Merged

docs: improve README visual hierarchy#95
Coding-Dev-Tools merged 1 commit into
mainfrom
codex/readme-visual-hierarchy

Conversation

@Coding-Dev-Tools

Copy link
Copy Markdown
Owner

Summary

  • place the live Knowledge Graph screenshot first in the README visual sequence
  • retain the project-memory flow next, then show a redesigned evidence-backed examples graphic
  • improve evidence-card type size, contrast, and spacing while preserving deterministic-fixture boundaries

Validation

  • python -m pytest -o addopts='' tests/test_benchmark_evidence.py tests/test_commercial_hardening.py tests/test_licensing_boundary_docs.py tests/test_pro_cta.py -q
  • ruff check .
  • image canvas and SVG-wrapper dimensions match
  • README remains 20.05% shorter than the original

@Coding-Dev-Tools
Coding-Dev-Tools merged commit 27dc74a into main Jul 30, 2026
11 checks passed

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bed2f7a0d1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md

<p align="center">
<img src="docs/images/evidence-backed-agent-examples.png" alt="Three evidence-backed examples: focused context holds Recall at 5 while reducing retrieved tokens, answerable questions return supported evidence, and off-topic questions abstain" width="100%">
<img src="docs/images/evidence-backed-agent-examples.png" alt="Three evidence-backed examples: focused context keeps Recall at 5 while reducing returned content, answerable questions return cited support, and unsupported questions explicitly abstain" width="100%">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore per-card fixture scope in the replacement image

The replacement graphic no longer names the long-document versus grounded fixture, or each fixture's document/question scope, on the individual cards; it provides only a global pair of commands. This contradicts the adjacent caption claiming that each card names its deterministic fixture and test scope, so readers cannot tell which fixture supports each displayed result. Restore the per-card labels or revise the caption to describe the graphic accurately.

AGENTS.md reference: AGENTS.md:L220-L222

Useful? React with 👍 / 👎.

<svg xmlns="http://www.w3.org/2000/svg" width="1693" height="929" viewBox="0 0 1693 929" role="img" aria-labelledby="title desc">
<title id="title">Three evidence-backed Engraphis agent behaviors</title>
<desc id="desc">A clear three-card summary of deterministic offline fixtures. Focused context returns 808.8 → 218.4 tokens while retaining Recall at 5 of 1.000. A grounded answer returns support for 5/5 answerable questions grounded. An unsupported question safely abstains for 5/5 off-topic questions abstained. Reproduce with eval.chunking_eval and eval.grounded.</desc>
<image href="evidence-backed-agent-examples.png" width="1693" height="929"/>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Make the eval test validate the rendered values

When this PNG is regenerated with different visible numbers, test_example_visual_uses_the_checked_in_offline_fixture_results will still pass: it searches the SVG source and now finds every expected result only in the manually duplicated <desc>, while this line renders the opaque PNG and test_readme_visual_pngs_match_their_svg_canvas verifies dimensions only. Previously those assertions matched rendered SVG text elements, so the evaluation gate no longer validates the public-facing claims; keep the values in rendered SVG content or add a generation/verification mechanism tied to the PNG.

AGENTS.md reference: AGENTS.md:L154-L155

Useful? React with 👍 / 👎.

@Coding-Dev-Tools
Coding-Dev-Tools deleted the codex/readme-visual-hierarchy branch July 31, 2026 05:44
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