Skip to content

docs(contexts): organize design guidance for agents#116

Merged
keli-wen merged 4 commits into
masterfrom
codex/issue-115-design-contexts
Jul 17, 2026
Merged

docs(contexts): organize design guidance for agents#116
keli-wen merged 4 commits into
masterfrom
codex/issue-115-design-contexts

Conversation

@keli-wen

@keli-wen keli-wen commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Creates one place for QuantMind design guidance and explains the planned Paper extraction process before further Paper or PageIndex implementation.

  • Adds a single design index with direct package and feature folders.
  • Adds a plain-language Quick Summary and complete Contents preview to every context page. Agents read the first 80 lines to choose a page, then read the full page when it applies.
  • Rewrites all 10 context pages with concrete headings, shorter sentences, and explanations for necessary technical terms.
  • Defines Paper extraction from input to a validated Paper. A model or PageIndex may suggest sections; code creates the final IDs, tree links, page ranges, citations, and source-backed text.
  • Keeps PageIndex optional behind a small PaperSourceDocument -> draft interface.
  • Moves the existing News and operation-naming guidance into the design index.
  • Replaces the obsolete generic storage design with the current local knowledge library: stored knowledge is preserved, while search text and embeddings can be rebuilt.
  • Adds a fixed four-page test PDF and offline tests for page anchors, tree shape, validation rules, and overlapping sibling page ranges.
  • Updates repository, contributor, catalog, and usage links and removes the superseded docs/design/ copies.

Related Issue

Closes #115

Verification

  • ./scripts/verify.sh — 323 tests passed, 86.47% coverage, 6 import rules kept.
  • Rendered and visually inspected all four pages of tests/fixtures/paper/golden/paper.pdf.
  • No live-network behavior changed, so no component live check applies.
  • Pre-commit and pre-push hooks passed without bypassing checks.

Checklist

  • The title uses English Conventional Commit format: type(scope): summary.
  • The related issue or design discussion is linked when applicable.
  • bash scripts/verify.sh passes.
  • Every applicable live-network check passes, or this PR states why none applies.
  • Public behavior has focused tests, an example, and documentation where applicable.
  • The PR is complete and contains no unrelated changes.

@keli-wen keli-wen added area: contexts Repository information routing and discovery under contexts/ area: flows Public operation implementations under quantmind/flows/ type: design Architecture decision or design before implementation labels Jul 16, 2026 — with ChatGPT Codex Connector
@keli-wen keli-wen changed the title docs(contexts): establish canonical design contracts docs(contexts): organize design guidance for agents Jul 17, 2026
@keli-wen keli-wen self-assigned this Jul 17, 2026
@keli-wen
keli-wen marked this pull request as ready for review July 17, 2026 07:16
@keli-wen
keli-wen merged commit f0a0a0b into master Jul 17, 2026
1 check passed
@keli-wen
keli-wen deleted the codex/issue-115-design-contexts branch July 17, 2026 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: contexts Repository information routing and discovery under contexts/ area: flows Public operation implementations under quantmind/flows/ type: design Architecture decision or design before implementation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(contexts): establish canonical design contexts and the Paper E2E contract

1 participant