Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
247 lines (169 loc) · 5.48 KB

DOCUMENTATION_INDEX.md

File metadata and controls

247 lines (169 loc) · 5.48 KB

📚 Documentation Index - Candlestick Library

Complete guide to all documentation in the Candlestick library.

🚀 Getting Started

Start here if you're new:

  1. README.md - Main documentation, quick start, API overview
  2. examples/ - Working code examples
  3. CHANGELOG.md - See what's new in v1.1.0

📖 Core Documentation

README.md

Main library documentation

  • Quick Start (CommonJS, ESM, TypeScript)
  • Installation
  • Usage examples
  • All 19 patterns documented (29 variants)
  • Pattern chaining
  • Data validation
  • Plugin system basics
  • Streaming API
  • FAQ

ARCHITECTURE.md

Technical architecture guide

  • Design principles
  • Directory structure
  • Core components
  • Data flow
  • Performance optimizations
  • Pattern implementation guidelines
  • Future considerations

CHANGELOG.md

Release history

  • v1.2.0 (2025-10-18) - Latest
    • 3 new patterns (Marubozu, Spinning Top, Tweezers)
    • Streaming API for large datasets
    • Property-based testing
    • 306 tests, 99.75% coverage
  • v1.1.0 (2025-10-17)
    • 6 new patterns
    • ESM support, TypeScript, Plugin system
  • Previous versions

ROADMAP.md

Future plans

  • Near-term goals (mostly ✅ completed)
  • Medium-term goals (🔜 planned)
  • Long-term goals
  • Community feedback

🔌 Advanced Features

docs/PLUGIN_API.md

Plugin system complete guide

  • API reference
  • registerPattern(), unregisterPattern(), etc.
  • Pattern detection functions
  • Metadata system
  • Integration with patternChain
  • Best practices
  • Examples

🤝 Contributing

CONTRIBUTING.md

How to contribute

  • Bug reports and feature requests
  • Coding standards
  • Running tests
  • Linting & formatting
  • Pull request checklist
  • Adding new patterns guide

CODE_OF_CONDUCT.md

Community standards

  • Expected behavior
  • Enforcement

SECURITY.md

Security policy

  • Reporting vulnerabilities
  • Security best practices

💻 Code Examples

examples/README.md

Examples guide

  • How to run examples
  • Available examples (14 total):
    • Single candle patterns (3)
    • Two candle patterns (4)
    • Multi-pattern detection (5)
    • Utilities (1)
    • Metadata (1)

📊 Quick Reference

File Structure

candlestick/
├── README.md                 # Start here
├── ARCHITECTURE.md           # Technical details
├── CHANGELOG.md              # What's new
├── ROADMAP.md                # Future plans
├── CONTRIBUTING.md           # How to contribute
├── docs/
│   ├── README.md             # Docs index
│   └── PLUGIN_API.md         # Plugin guide
├── examples/
│   ├── README.md             # Examples guide
│   └── *.js, *.mjs           # 11 working examples
└── types/
    └── index.d.ts            # TypeScript definitions

Quick Links

For Users:

For Developers:

For Traders:

For Maintainers:

docs/ Directory:

The docs/ directory contains specialized guides:

📊 Stats

  • Total Docs: 10 markdown files (essential documentation)
  • Examples: 14 working examples
  • Patterns Documented: 19 unique patterns (29 variants)
  • API Functions Documented: 53+
  • Tests: 306 (99.75% coverage)
  • CLI Commands: 1 (candlestick)
  • Metadata System: Complete (confidence, type, strength, direction)
  • Streaming API: Available for large datasets
  • Last Updated: October 18, 2025 (v1.2.0)

🔍 Search by Topic

Patterns:

TypeScript:

ESM:

Plugins:

Validation:

Metadata:

CLI:

Contributing:

Need help? Open an issue on GitHub.