Skip to content

Latest commit

 

History

History
132 lines (114 loc) · 18.3 KB

index.md

File metadata and controls

132 lines (114 loc) · 18.3 KB

QOpenBB documentation

The prototype is deployed. Start with the first-spec closure for completed work and the investment-analysis contract for the next analyst experience.

The login correction is published in alpha-40676586728-1. Existing-password authentication and bootstrap password replacement are verified within the documented local scope.

Company selection is available in alpha-42188370167-1: find an FMP listing by name or symbol and align compatible research widgets. Publication verification records the public images and install assets.

Choose your next action

Native Windows development is accepted using Podman Compose, with Dagger building images only and outputs under D:/BuildArtifacts/QOpenBB. See the native migration closeout and financial browser acceptance. These qualified local images do not constitute a new release or server deployment.

Your task Start here
Install prebuilt alpha images for development Installation guide
Connect the bundled backend and open starter dashboards First login and onboarding
Find companies by name and link research widgets Company selection
Open the curated Company Research App and inspect original observations Company Research guide
Keep account connections and saved dashboards across updates Persistence and updates
Check verified company inputs and remaining financial gaps Company Research input assessment
Plan a feature using existing OpenBB capabilities Capability reuse map
Understand login and bootstrap password replacement Login correction and verification
Configure optional remote access Tips and Tricks
Understand the purpose and operating boundaries Goals
See the sequence and owning specifications Roadmap
Review house financial methods and the separate modeling layer House-standard reflection and proposed architecture
Extend financial models with executable validation and compatible widgets Modeling repository stub and extension blueprint
Build, verify and prepare the prototype for installation Prototype delivery
Map FMP, FRED and Yahoo coverage to research needs Provider coverage
Inspect the eleven added FMP inputs and four verified local widgets Batch A coverage and task evidence
Inspect the eight FMP event and document inputs and five verified local widgets Batch B coverage and task evidence
Inspect the verified commodity, technology and macro inputs for the first research story Cross-asset and macro inputs, result record and task evidence
Review the accepted Company Research scope Implementation tasks, amendment review, reviewed design, requirements and readiness reconciliation
Upgrade strict statement consumers and interpret period evidence Statement provenance migration
Review the financial schema projection prerequisite Authoritative annotation repair
Choose a chart for an analyst question Historical chart guide (36 chart screenshots, historical data recipes and interpretation)
Check renderer responsibilities and done/todo lists ECharts, FINOS Perspective and Plotly
Check which capabilities have actual evidence Breadth map and reviewed artifacts
Set up development or contribute Development and contribution guide
Run the native Windows workflow Development entry point and verification
Keep verification focused and artifacts manageable Verification and artifact retention
Review automated security analysis CodeQL coverage and status

Current deployment boundary

The prototype combines Full Workspace and the self-hosted OpenBB data API in root Compose. It serves HTTP on port 23003 behind owner-managed Cloudflare Access and cloudflared, with relative bind-mounted state. Dagger builds images; portable commands handle verification and publication. Development installs pull prebuilt latest images; each release manifest also records immutable references.

The current alpha delivers the 25-task FMP Batch B increment on top of Batch A, the accepted Company Research App and the historical gallery. Batch B adds eight event and document inputs. Provider coverage distinguishes scoped live API checks for all eight from five representative local widget journeys. Publication verification covers three public assets, six anonymous image pulls, a network-isolated check of 20 synthetic Batch B cases with zero provider requests, and the published pair's identity, readiness and login through its isolated internal network. Windows host-loopback transport for this published pair remains unverified after the failed host checks. Financial browser acceptance used different local images; no CI-image financial browser run is claimed. The owner deployment report still applies only to the earlier company-selector release; no new owner-server deployment or infrastructure recovery is claimed.

Broader FMP/FRED/Yahoo coverage belongs to market-data-integrations. Reusable widgets, linked research context, commands, theme and renderer completion belong to analyst-workspace. AI, Excel and custom sources have separate specs. Dashboard persistence acceptance is part of the analyst spec; infrastructure recovery verification is deferred. See spec ownership for transferred obligations.

Technical reference and historical evidence

Earlier findings remain available to explain implementation decisions and reproduce checks. Their next-step language reflects the work at that time. The agile delivery amendment and current roadmap govern sequencing.

Browse implementation records and technical guides
If you need to... Read
Understand the intended financial workflow and its limits Goals
Map provider coverage to research widgets, commands and linked time views Provider coverage and widget requirements
Find the next dependency gate Roadmap and implementation tasks
Check prototype packaging, CI and remaining release gates Prototype delivery
Track concrete production changes needed for the original UI UI parity worklist
See the path from accepted chart modules to the original application experience Completion plan
Inspect the latest original chart appearance and editor contracts Runtime findings and next boundary
Review the next appearance and tooltip implementation boundary Appearance/editor design amendment
Verify saved appearance, derived colors and tooltip state contracts Appearance source verification
Locate the contracts still needed for the original chart/editor journey Consuming integration readiness
Inspect concrete appearance/session handoffs and their remaining gates Consuming contract draft
Check original axis stroke, grid width and dash behavior Axis/grid findings
Reproduce editor close/reopen, theme changes and table return UI navigation findings
Preserve independent captions, Weight choices and chart padding Caption and padding findings
Preserve color-picker alpha, keyboard behavior and Series Shadow Color and Shadow findings
Review axis controls, type-transition resets and unchanged time-format rendering Axis-control findings
Review tooltip content, missing-value behavior and unresolved picked ownership Tooltip invocation findings
Prepare the remaining Legend capture with reviewed measurement limits Legend capture plan
Separate tab resets from chart-family and saved-range changes Family navigation plan
Review the existing-backend persistence repair SQLite query design
Reproduce SQLite query and storage checks SQLite verification
Set up the pinned development tools Development toolchain
Check maintained code size and explicit fork scope Complexity checks
Validate source, release and acceptance records Evidence contracts
Keep development checks and committed evidence compact Artifact retention
Inspect selected-service inputs and build-source exclusions Runtime and source contracts
Run isolated fixture browser and API checks Verification infrastructure
Inspect the foundation image workflow and its evidence limits Image builds
Restore the locked data runtime and inspect FRED semantics Data runtime
Inspect the restored FMP package and installed discovery checks FMP adaptation
Rebuild the provisional Full frontend from frozen inputs Workspace frontend packaging
Assess what has actually been tested Feasibility report and breadth map
Browse committed screenshots, fixtures and verification records Reviewed artifacts
Review acceptance criteria or approve the next phase Requirements and phase status
Review service contracts, file ownership and acceptance gates Technical design
Understand proposed services and compatibility risks Research and Full versus Lite
Inspect acquired sources, package compatibility and asset constraints Compatibility and licenses
Decide the open-source chart and table baseline Replacement assessment
Track features that the renderer replacement must preserve Renderer parity audit
Inspect original chart types, controls, flags and required checks Renderer capability matrix
Understand original saved chart settings and the next adapter boundary Original option findings
Review the explicit chart appearance contract Explicit appearance design
Review the latest original-runtime captures and next adapter boundary Runtime contracts and next steps
Verify ordinary displayed-grid financial capture Grid-capture verification
Review source-safe chart helpers and remaining runtime joins Application helper verification
Review the next real Workspace chart journey and outstanding contracts Application integration draft
Inspect original grid selection, range and chart-state inputs Grid range source contract
Check explicit appearance implementation and browser evidence Appearance verification
Inspect original line, title and marker observations Line appearance findings
Check original option-state implementation evidence Option-state verification
Inspect remaining effective chart styling contracts Effective-style discovery
Inspect observed original dark-theme defaults Resolved-theme findings
Inspect original light/dark defaults for the three initial chart families Stock theme matrix
Inspect saved custom palettes and background inheritance Custom-theme findings
Check original numeric, fiscal-date and tooltip formatting rules Formatting contract
Inspect nested-editor discovery results and remaining gates Editor runtime ledger
Review the renderer compatibility investigation and parallel work Discovery plan and research
Check what the renderer probes actually established Discovery results
Compare original and candidate widget controls Paired widget findings
Inspect the selected ECharts integration boundary and remaining gaps ECharts findings
Review the proposed chart adapter and original editor scope Integration proposal and editor contract
Review the next isolated chart mapping boundary Snapshot design and grid/SQLite findings
Verify the isolated ECharts dependency, host and mappings Chart foundation and snapshot verification
Contribute code, comments, evidence, or documentation Contribution guide

Find the authoritative detail

Requirements own acceptance criteria; spec.json records approval state. Research and verification records describe findings for their stated revisions. sources.lock.json pins acquired source revisions, not a published release. The breadth map connects capabilities to criteria, actual test paths and evidence; planned checks do not count as passing tests.

Project rules live in AGENTS.md and steering: documentation, complexity, testing, CI, delivery workflow and delegation.