Skip to content

docs(product): align public framing across roadmap docs#441

Merged
Whiteks1 merged 1 commit intomainfrom
codex/issue-440-public-framing
Apr 21, 2026
Merged

docs(product): align public framing across roadmap docs#441
Whiteks1 merged 1 commit intomainfrom
codex/issue-440-public-framing

Conversation

@Whiteks1
Copy link
Copy Markdown
Owner

@Whiteks1 Whiteks1 commented Apr 21, 2026

Summary

  • align secondary product-direction docs with the current QuantLab public framing
  • reframe UI references as structural references, not brand/product identity
  • rewrite Stepbit/QuantLab use cases around supervision, artifacts, and non-sovereign orchestration

Scope

Docs-only consistency sweep for #440.

Out of scope:

  • no code changes
  • no UI implementation
  • no N.1 implementation
  • no ML dependencies
  • no paper/broker/execution changes

Validation

  • git diff --check

Closes #440

Summary by Sourcery

Align QuantLab documentation with the current public framing by redefining product use cases and UI references around evidence authority, supervision, and non-sovereign orchestration.

Documentation:

  • Rewrite QuantLab–Stepbit use cases to emphasize supervised research, artifact-based evidence, and explicit non-goals around autonomous trading or risk ownership.
  • Reframe UI product-direction references as structural and workflow inspirations rather than brand or product-identity targets, clarifying QuantLab’s role as an analytical, evidence-first workstation.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Apr 21, 2026

Reviewer's Guide

Documentation-only PR that reframes QuantLab/Stepbit public positioning and UI product references: it replaces autonomous/agentic IA narratives with supervised, evidence-centric use cases and clarifies that external product references are structural patterns, not brand or positioning targets.

Sequence diagram for the supervised strategy research loop use case

sequenceDiagram
    actor Operator
    participant Stepbit
    participant QuantLab

    Operator->>QuantLab: Define research question (e.g. mean reversion with RSI)
    Operator->>Stepbit: Optionally request candidate parameters or workflow steps
    Stepbit-->>Operator: Propose parameter sets and research steps

    Operator->>QuantLab: Run backtests with selected parameters
    QuantLab-->>Operator: Produce canonical artifacts (report.json, metrics, stability, drawdown)

    Operator->>Operator: Review artifacts and evidence
    Operator->>Stepbit: Optionally request summary of trade-offs
    Stepbit-->>Operator: Summarize trade-offs based on QuantLab artifacts

    Operator->>Operator: Form supervised research shortlist (no autonomous trading decision)
Loading

File-Level Changes

Change Details Files
Rewrote QuantLab + Stepbit use-case document to emphasize supervised, evidence-centric workflows and clear non-goals instead of autonomous AI/trading narratives.
  • Replaced Spanish, agentic IA-focused scenarios with English, bounded use cases centered on QuantLab as the evidence authority and Stepbit as optional orchestration/interpretation support.
  • Redesigned each use case to explicitly describe goal, operator-supervised flow, and constrained results (research shortlist, paper-session discipline, broker-safety review, reporting, and future learned-model assistance).
  • Added a Non-Goals section that explicitly rules out autonomous live trading, Stepbit-owned strategy or risk authority, unsupervised broker execution, and unsupported learned-model promotion.
docs/use-cases.md
Adjusted research UI product-direction document to treat external products as structural references and to reframe QuantLab’s identity around evidence, supervision, and analysis rather than fintech/AI branding.
  • Changed MLflow/QuantConnect/W&B references into generic structural/workflow/comparison references, avoiding direct brand/identity alignment and live-trading framing.
  • Updated QuantLab identity description from SaaS/fintech/web3 mix to a dark analytical instrument and supervised research workstation with evidence and operator control as primary concerns.
  • Tightened visual guidelines to avoid fintech or generic AI product cues and to keep venue awareness and learned-model support clearly secondary to evidence and traceability.
docs/research-ui-product-direction.md

Assessment against linked issues

Issue Objective Addressed Explanation
#440 Align secondary product/framing docs with the current QuantLab positioning and remove/reframe wording that makes QuantLab sound like a crypto app, fintech SaaS, generic AI product, or autonomous trading agent.
#440 Frame Stepbit-related use cases so that QuantLab remains the evidence/validation authority and Stepbit is positioned as optional, supervised, non-sovereign orchestration/reasoning support (not autonomous trading authority).
#440 Update roadmap/secondary product-direction docs so that external products (MLflow, QuantConnect, W&B, etc.) are referenced only as structural/UX references, not as brand or product-identity anchors, and avoid crypto/fintech/generic AI product cues in the UI framing.

Possibly linked issues


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

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

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 updated use-cases document switches from Spanish to English; if this is intentional, consider confirming language consistency expectations across the rest of the docs set so readers aren’t surprised by mixed locales.
  • In the new non-goals and authority language (e.g., around Stepbit vs QuantLab, and N.0/N.1/N.2), consider adding a brief cross-reference or definition in a shared concepts doc to avoid ambiguity for readers who encounter these terms here first.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The updated use-cases document switches from Spanish to English; if this is intentional, consider confirming language consistency expectations across the rest of the docs set so readers aren’t surprised by mixed locales.
- In the new non-goals and authority language (e.g., around Stepbit vs QuantLab, and N.0/N.1/N.2), consider adding a brief cross-reference or definition in a shared concepts doc to avoid ambiguity for readers who encounter these terms here first.

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.

@Whiteks1 Whiteks1 merged commit 3aea553 into main Apr 21, 2026
3 checks passed
@Whiteks1 Whiteks1 deleted the codex/issue-440-public-framing branch April 21, 2026 14:40
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.

docs(product): align public framing across roadmap docs

1 participant