Skip to content

[Docs] window metadata description #22

@MDUYN

Description

@MDUYN

Indicator / Feature Name

all indicators

What needs to happen?

Improve existing documentation (unclear, incomplete, outdated)

Current Docs Page (if exists)

No response

What's Missing or Wrong?

Standardize Indicator Documentation and Metadata

To improve consistency, transparency, and comparability across indicators, all indicator documentation should include a standardized parameter summary table and clearly described metadata sections.

1. Indicator Parameter Table

Each indicator must include the following table in its documentation:

Parameter | Value -- | -- Look-ahead bias | yes / no — If yes, mention whether a version of the indicator exists without look-ahead bias Warmup window | Number of required warmup periods or reference to the relevant parameter Window | Fixed number or reference to the parameter defining the window Lookback window | yes / no / number or reference to the relevant parameter

2. Indicator Category Tables

All indicator category pages (e.g., Momentum, Trend, Volatility, etc.) should update their indicator overview tables to include these same parameters:

  • Look-ahead bias

  • Warmup window

  • Window

  • Lookback window

This allows users to quickly compare indicators within a category.


3. Individual Indicator Sections

Each indicator page should individually describe these properties in its documentation, not only in the table.

The description should clarify:

  • Whether the indicator has look-ahead bias

  • Whether a bias-free implementation exists

  • The required warmup period

  • Any window or lookback requirements

These explanations should appear in the indicator’s documentation sections so users understand the implications for backtesting and live trading.


Goal

Standardizing this metadata helps users:

  • Quickly identify indicators safe for backtesting

  • Understand data requirements and warmup periods

  • Compare indicators across categories

  • Avoid look-ahead bias errors in strategies

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