Skip to content

docs(positioning): agent-native narrative — canonical positioning page, README restructure, contributor setup skill#142

Merged
keli-wen merged 5 commits into
masterfrom
docs/positioning-alignment
Jul 23, 2026
Merged

docs(positioning): agent-native narrative — canonical positioning page, README restructure, contributor setup skill#142
keli-wen merged 5 commits into
masterfrom
docs/positioning-alignment

Conversation

@keli-wen

Copy link
Copy Markdown
Contributor

Summary

Aligns the repository's narrative with the converged July 2026 positioning: QuantMind is an agent-native workbench for financial knowledge extraction, structured by two engineering dimensions — context engineering (any source → typed knowledge) and harness engineering (any agent → domain specialist). This PR lands the canonical positioning page, restructures the README around that story, and makes the README's agent-native contributing prompts real.

Changes

  • contexts/design/positioning.md (new) — the single canonical positioning source: positioning and hero, the two dimensions, the bet, evaluation (design phase, no results claimed), the LLMQuant Data relationship, and the roadmap. The V1/V2 labels are documented as a poster-only contrast device; serious prose uses the dimension names. Registered in the design index and CONTEXT_MAP.md. Supersedes the April positioning spec.
  • README.md — workbench-first restructure: original slogan restored; Knowledge Engineering and The Vision sections with the two architecture figures; agent-path-first Quick Start with PaperStructureCfg / PaperSemanticCfg examples on one PaperFlow; a design-phase evaluation [!NOTE] referencing Anthropic's "Demystifying evals for AI agents"; LLMQuant Data production section with screenshot; direction-based roadmap; agent-native contributing prompts. Prose is unwrapped (no fixed-width hard wrapping).
  • AGENTS.md — positioning paragraph aligned to the dimension names and linked to the canonical page.
  • quantmind-dev skill — new references/setup.md (contributor setup and issue filing) with SKILL.md routing so the README prompts (set me up as a contributor, file an issue, contribute a change) resolve; mirrored byte-identically under .agents/.
  • contexts/dev/github-writing.md — the no-hard-wrap prose rule now also covers README.md.
  • Assets — the two architecture figures and the LLMQuant Data screenshot used by the README.

This branch also carries two pending follow-up commits from feat/harness-close-134-pr-title-and-boundary (repo-root-relative cross-references in skills and contexts) that had no open PR of their own.

Verification

bash scripts/verify.sh green (ran in the pre-push hook); tests/test_contexts.py passes with the new page registered. README example symbols (PaperFlow, PaperStructureCfg, PaperSemanticCfg, collect_news, batch_run) verified against quantmind/flows and quantmind/configs exports on master after #140.

🤖 Generated with Claude Code

keli-wen and others added 4 commits July 23, 2026 18:06
…it-body wrap rule

Completes the remaining #134 work.

- .github/workflows/pr-title.yml lints the PR title (which becomes the squash-merge commit subject) as an English Conventional Commit, reusing scripts/hooks/commit_msg_check.py so the convention keeps one source. This is the server-side floor for external contributors, whom the local commit-msg git hook cannot bind because it only fires after `pre-commit install`.
- contexts/README.md now states the contexts/ vs docs/ boundary explicitly: contexts/ is internal navigation and design memory for agents and maintainers; docs/ is the user-facing catalog and guides. This was the last open acceptance criterion in #134.
- commit.md (both skill copies) adds the commit-body convention: follow the same no-hard-wrap prose rule as GitHub bodies, so a squash-merge keeps a clean description. This commit message follows it — one physical line per list item.
- contexts/dev/harness-engineering.md records the PR-title lint in the enforcement table and notes that making it a required status check is a one-time repo-settings toggle.

verify.sh passes (426 passed, 85.65% coverage).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…/ link

The commit-body rule referenced github-writing.md via `../../../../contexts/dev/github-writing.md`, matching the repo's tested clickable-link convention but reading badly. commit.md is not test-bound to that link, so use a readable repo-root-relative backtick reference instead.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…with data-mono)

Skill files referenced contexts pages with deep, fragile clickable links like `../../../../contexts/dev/github-writing.md`. The sister repo llmquant-data-mono instead uses repo-root-relative backtick references (`contexts/...`) from nested files, because a clean clickable repo-root link is only possible from a root-level file — GitHub resolves a bare relative link against the current file's directory, not the repo root, so a nested file needs the ugly `../` chain to stay clickable.

- SKILL.md and pull-request.md (both skill copies) now reference contexts pages as repo-root backtick paths (`contexts/README.md`, `contexts/dev/labels.md`, `contexts/dev/github-writing.md`) instead of `../../../` links. Root-level files (AGENTS.md) and sibling contexts pages keep their clean clickable links.
- tests/test_contexts.py: the three route tests now check that each source references the canonical guide in the form appropriate to its location — a backtick repo-root reference for nested skill files, a clickable link for root or sibling pages — and that the guide exists at the repo root, instead of asserting a specific deep relative link path.

verify.sh passes (426 passed, 85.65% coverage).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…estructure, contributor setup

- contexts/design/positioning.md: canonical positioning source (context engineering / harness engineering as dimensions of one repo; V1/V2 kept only as a poster-mapping note), registered in the design index and CONTEXT_MAP
- README.md: workbench-first restructure — original slogan restored, Knowledge Engineering + The Vision sections with figures, agent-path quick start, PaperSemanticCfg examples, design-phase evaluation NOTE with the Anthropic evals reference, LLMQuant Data screenshot, direction-based roadmap, agent-native contributing prompts
- AGENTS.md: positioning paragraph aligned to the dimension names
- quantmind-dev skill: new references/setup.md (contributor setup + issue filing) with SKILL.md routing, mirrored byte-identically to .agents
- github-writing: no-hard-wrap rule extended to README.md

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@keli-wen keli-wen added type: docs Primary deliverable is documentation or guidance area: harness Contributor and agent controls, CI, hooks, skills, and rulesets area: contexts Repository information routing and discovery under contexts/ labels Jul 23, 2026
@keli-wen keli-wen self-assigned this Jul 23, 2026
Resolve README.md quick-start conflict: keep the dual-cfg PaperFlow
examples (structure tree + semantic, with master's real result fields)
and adopt master's batch_run and magic examples.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@keli-wen
keli-wen merged commit 638d16a into master Jul 23, 2026
1 check passed
@keli-wen
keli-wen deleted the docs/positioning-alignment branch July 23, 2026 19:06
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: harness Contributor and agent controls, CI, hooks, skills, and rulesets type: docs Primary deliverable is documentation or guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant