Skip to content

Commit 5a2c4c2

Browse files
MDUYNMDUYN
committed
Add documentation page
1 parent d5da2f3 commit 5a2c4c2

20,703 files changed

Lines changed: 1633602 additions & 3 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.copilot/mcp-config.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"mcpServers": {
3+
"EXAMPLE-trello": {
4+
"command": "npx",
5+
"args": [
6+
"-y",
7+
"@trello/mcp-server"
8+
],
9+
"env": {
10+
"TRELLO_API_KEY": "${TRELLO_API_KEY}",
11+
"TRELLO_TOKEN": "${TRELLO_TOKEN}"
12+
}
13+
}
14+
}
15+
}

‎.gitattributes‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Squad: union merge for append-only team state files
2+
.squad/decisions.md merge=union
3+
.squad/agents/*/history.md merge=union
4+
.squad/log/** merge=union
5+
.squad/orchestration-log/** merge=union

‎.github/ISSUE_TEMPLATE/new-indicator.yml‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
name: "🔧 New Indicator"
2+
description: "Request a new technical indicator implementation"
3+
title: "[Indicator] "
4+
labels: ["squad", "indicator"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## New Indicator Request
10+
Use this template to request a new indicator for PyIndicators.
11+
**Include chart screenshots** showing the expected output — the team needs visual references to reproduce the behavior accurately.
12+
13+
- type: input
14+
id: indicator-name
15+
attributes:
16+
label: Indicator Name
17+
description: "The name of the indicator (e.g., Parabolic SAR, Ichimoku Cloud)"
18+
placeholder: "e.g., VWAP (Volume Weighted Average Price)"
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: category
24+
attributes:
25+
label: Category
26+
description: "Which category does this indicator belong to?"
27+
options:
28+
- Trend
29+
- Momentum
30+
- Volatility
31+
- Support & Resistance
32+
- Pattern Recognition
33+
- Volume
34+
- Helpers / Utilities
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: description
40+
attributes:
41+
label: Description
42+
description: "What does this indicator do? How is it used in trading?"
43+
placeholder: "Describe the indicator's purpose, what it measures, and typical use cases..."
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: reference-chart
49+
attributes:
50+
label: Reference Chart(s)
51+
description: |
52+
**Paste or drag & drop chart screenshots** showing the expected indicator output.
53+
Include charts from TradingView, PineScript, or any other platform.
54+
The more visual references, the better — these are used to verify the implementation.
55+
placeholder: "Drag and drop images here, or paste image URLs..."
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: chart-description
61+
attributes:
62+
label: Chart Description
63+
description: |
64+
**Describe what the chart(s) show** — agents may not always be able to see images.
65+
Include: timeframe, asset, what lines/zones/signals are visible, colors, behavior at key points.
66+
placeholder: |
67+
- Timeframe: Daily
68+
- Asset: BTC/USD
69+
- The indicator shows a green line above price during downtrends and red line below during uptrends
70+
- Signals are marked with triangles at crossover points
71+
- ...
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: parameters
77+
attributes:
78+
label: Parameters
79+
description: "List the indicator's parameters with types and defaults"
80+
placeholder: |
81+
- `period` (int, default=14): Lookback period
82+
- `multiplier` (float, default=2.0): ATR multiplier
83+
- `source` (str, default='Close'): Source column
84+
value: |
85+
- `period` (int, default=14):
86+
- `source_column` (str, default='Close'):
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
id: source-reference
92+
attributes:
93+
label: Source / Reference
94+
description: "Link to PineScript source, academic paper, or reference implementation"
95+
placeholder: "e.g., https://www.tradingview.com/script/... or a PineScript code block"
96+
validations:
97+
required: false
98+
99+
- type: textarea
100+
id: output-columns
101+
attributes:
102+
label: Expected Output Columns
103+
description: "What columns should the indicator add to the DataFrame?"
104+
placeholder: |
105+
- `indicator_value`: Main indicator line
106+
- `indicator_signal`: Buy/sell signal (1, -1, 0)
107+
- `indicator_upper`: Upper band
108+
- `indicator_lower`: Lower band
109+
validations:
110+
required: false
111+
112+
- type: checkboxes
113+
id: deliverables
114+
attributes:
115+
label: Deliverables Checklist
116+
description: "A complete indicator requires ALL of the following. The squad will handle each."
117+
options:
118+
- label: "Implementation in `pyindicators/indicators/` (pandas + polars support)"
119+
required: true
120+
- label: "Exports in `__init__.py` and `__all__`"
121+
required: true
122+
- label: "Unit tests in `tests/indicators/` (pandas, polars, edge cases)"
123+
required: true
124+
- label: "Documentation page in `docs/content/indicators/` with chart image"
125+
required: true
126+
- label: "Sidebar registration in `docs/sidebars.js`"
127+
required: true
128+
- label: "Entry in README.md features list"
129+
required: true
130+
- label: "Analysis notebook in `analysis/indicators/` with plotly chart"
131+
required: true
132+
133+
- type: textarea
134+
id: additional-context
135+
attributes:
136+
label: Additional Context
137+
description: "Anything else? Special edge cases, related indicators, priority notes..."
138+
placeholder: "Optional additional context..."
139+
validations:
140+
required: false

0 commit comments

Comments
 (0)