Skip to content

[Docs] "Warmup Window” column to overview page #20

@MDUYN

Description

@MDUYN

Indicator / Feature Name

All indicator categories overviews

What needs to happen?

Improve existing documentation (unclear, incomplete, outdated)

Current Docs Page (if exists)

No response

What's Missing or Wrong?

Add “Warmup Window” column to overview page

Description:
For many technical indicators, a warmup period is required before the indicator produces valid signals. This is distinct from the lag/lookback of the signal itself: the warmup window defines how many initial data points must be accumulated before the indicator can start outputting meaningful values.

Currently, the overview page does not display this information, which makes it difficult for strategy developers to plan backtests and understand when an indicator becomes usable.

Proposed improvement:

Add a new column on the overview page called “Warmup Window”.

For indicators where this applies, display the number of data points needed before the indicator outputs valid results.

If the warmup period is not applicable, leave the column empty or mark as N/A.

Benefit:
Showing the warmup window directly in the overview provides clarity for developers when building strategies or backtesting, ensuring indicators are used correctly from the first data point.

Expected Content

No response

Deliverables

  • New or updated Docusaurus documentation page
  • Add indicator to sidebar navigation
  • Add or update README section
  • Add chart image to docs page
  • Add code examples

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    squadSquad triage inbox — Lead will assign to a member

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions