Skip to content

Commit b1352e9

Browse files
committed
fix: Update links in documentation for consistency and accessibility
1 parent 688070d commit b1352e9

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

QUICKSTART.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -425,10 +425,10 @@ pip install TA_Lib‑0.4.XX‑cpXX‑cpXX‑win_amd64.whl
425425
Now that you've got the basics, explore more:
426426

427427
1. **[Full Documentation](https://xgboosted.github.io/pandas-ta-classic/)** - Complete API reference
428-
2. **[Tutorials](TUTORIALS.md)** - Step-by-step guides for common tasks
428+
2. **[Tutorials](https://github.com/xgboosted/pandas-ta-classic/blob/main/TUTORIALS.md)** - Step-by-step guides for common tasks
429429
3. **[Indicator Reference](https://xgboosted.github.io/pandas-ta-classic/indicators.html)** - All 203 indicators
430430
4. **[Strategy Guide](https://xgboosted.github.io/pandas-ta-classic/strategies.html)** - Advanced strategy system
431-
5. **[Examples](examples/)** - Jupyter notebooks with real examples
431+
5. **[Examples](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples)** - Jupyter notebooks with real examples
432432

433433
## 🎯 Quick Reference Card
434434

@@ -447,6 +447,6 @@ Now that you've got the basics, explore more:
447447

448448
- **Issues**: [GitHub Issues](https://github.com/xgboosted/pandas-ta-classic/issues)
449449
- **Discussions**: [GitHub Discussions](https://github.com/xgboosted/pandas-ta-classic/discussions)
450-
- **Examples**: Check the [examples/](examples/) directory
450+
- **Examples**: Check the [examples directory](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples)
451451

452452
Happy Trading! 📈

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ This is the **classic/community maintained version** of the popular pandas-ta li
2828

2929
**Get started quickly with our comprehensive guides:**
3030

31-
- **[🚀 Quickstart Guide](QUICKSTART.md)** - Installation, your first indicators, and common workflows
32-
- **[📚 Tutorials](TUTORIALS.md)** - Step-by-step tutorials for real-world use cases:
31+
- **[🚀 Quickstart Guide](https://github.com/xgboosted/pandas-ta-classic/blob/main/QUICKSTART.md)** - Installation, your first indicators, and common workflows
32+
- **[📚 Tutorials](https://github.com/xgboosted/pandas-ta-classic/blob/main/TUTORIALS.md)** - Step-by-step tutorials for real-world use cases:
3333
- Moving Average Crossover Strategy
3434
- Building Custom Indicator Strategies
3535
- Backtesting with Performance Metrics
@@ -149,9 +149,9 @@ df.ta.strategy("CommonStrategy") # Runs commonly used indicators
149149
### 📖 Learning Resources
150150

151151
**Start Here:**
152-
- 🚀 **[Quickstart Guide](QUICKSTART.md)** - Get up and running in minutes
153-
- 📚 **[Tutorials](TUTORIALS.md)** - Step-by-step guides for common workflows
154-
- **[Examples](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples)** - Jupyter notebooks with real examples
152+
- 🚀 **[Quickstart Guide](https://github.com/xgboosted/pandas-ta-classic/blob/main/QUICKSTART.md)** - Get up and running in minutes
153+
- 📚 **[Tutorials](https://github.com/xgboosted/pandas-ta-classic/blob/main/TUTORIALS.md)** - Step-by-step guides for common workflows
154+
- 📓 **[Examples](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples)** - Jupyter notebooks with real examples
155155

156156
**Reference Documentation:**
157157
- �📖 [**Usage Guide**](https://xgboosted.github.io/pandas-ta-classic/usage.html) - Programming conventions and basic usage
@@ -164,7 +164,7 @@ df.ta.strategy("CommonStrategy") # Runs commonly used indicators
164164

165165
**Pandas TA Classic** follows a **rolling support policy** for the latest stable Python version plus 4 preceding minor versions.
166166

167-
> **Note:** Python version support is **dynamically managed** via CI/CD workflows. When new Python versions are released, the library automatically updates to support the latest 5 minor versions. Check the [CI workflow](.github/workflows/ci.yml) `LATEST_PYTHON_VERSION` for the current configuration.
167+
> **Note:** Python version support is **dynamically managed** via CI/CD workflows. When new Python versions are released, the library automatically updates to support the latest 5 minor versions. Check the [CI workflow](https://github.com/xgboosted/pandas-ta-classic/blob/main/.github/workflows/ci.yml) `LATEST_PYTHON_VERSION` for the current configuration.
168168
169169
**Note:** _TA Lib_ installation enables all candlestick patterns:
170170
- Using `uv`: `uv pip install TA-Lib`
@@ -181,7 +181,7 @@ We welcome contributions! Please see our [contributing guidelines](https://githu
181181

182182
## 📋 Changelog
183183

184-
For detailed information about changes, improvements, and new features, please see the [CHANGELOG.md](CHANGELOG.md) file.
184+
For detailed information about changes, improvements, and new features, please see the [CHANGELOG.md](https://github.com/xgboosted/pandas-ta-classic/blob/main/CHANGELOG.md) file.
185185

186186
## 🔗 Sources
187187

@@ -195,4 +195,4 @@ If you find this library helpful, please consider:
195195

196196
## 📄 License
197197

198-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
198+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/xgboosted/pandas-ta-classic/blob/main/LICENSE) file for details.

TUTORIALS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -783,8 +783,8 @@ You've completed the tutorials! Here's what to explore next:
783783

784784
## 📚 Additional Resources
785785

786-
- [QUICKSTART.md](QUICKSTART.md) - Quick reference guide
787-
- [Examples Directory](examples/) - Jupyter notebooks
786+
- [QUICKSTART.md](https://github.com/xgboosted/pandas-ta-classic/blob/main/QUICKSTART.md) - Quick reference guide
787+
- [Examples Directory](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples) - Jupyter notebooks
788788
- [Indicator Reference](https://xgboosted.github.io/pandas-ta-classic/indicators.html) - All indicators
789789
- [Strategy Guide](https://xgboosted.github.io/pandas-ta-classic/strategies.html) - Advanced strategies
790790

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Pandas TA Classic - Technical Analysis Library
77

88
**Pandas Technical Analysis (Pandas TA Classic)** is an easy to use library that leverages the Pandas package with **141 indicators and utility functions** plus **62 TA-Lib candlestick patterns** (**203 total**). This is the **community maintained version** of the popular pandas-ta library.
99

10-
![Example Chart](images/TA_Chart.png)
10+
![Example Chart](https://raw.githubusercontent.com/xgboosted/pandas-ta-classic/main/images/TA_Chart.png)
1111

1212
## Features
1313

0 commit comments

Comments
 (0)