openbb-finance/widgets-library

This repository holds the visual assets and metadata for the widget library used in OpenBB Terminal Pro, a financial analysis platform. Its main purpose is to serve as a central hub for the images and descriptive details that power the documentation for the platform's various widgets, the small, modular panels users can add to their dashboards to display things like market indices or individual stock information. The core of the project is a file called widgets.json. This file acts as a directory that lists every available widget, giving each one a name, description, category, and a unique identifier. For example, a widget showing the S&P 500 or Nasdaq might be categorized under "equity" with a description explaining that it provides a market overview. The repository also stores a corresponding preview image for each widget, organized into folders by category so the documentation site can easily display what each widget looks like. The primary users of this repository are the developers and team members building the OpenBB Terminal Pro platform. When they create a new widget for the terminal, they add its details to the widgets.json file and upload a screenshot to the appropriate folder here. This keeps the public-facing widget documentation up to date, allowing users of the terminal to browse available widgets and understand what each one does before adding it to their dashboard. The project takes a straightforward approach: the widgets.json file is manually copied from the main Terminal Pro codebase into this repository, and images are then organized by category. This separates the visual documentation assets from the main application code, making it easier to manage the library of widget previews that populate the official docs site.