Documentation Index

This directory contains comprehensive documentation for the Apache IoTDB Node.js client.

📚 Documentation Categories

Getting Started

• Main README - Project overview, installation, and quick start
• Contributing Guidelines - How to contribute to the project
• Changelog - Version history and release notes

API & Usage

• Implementation Guide - Architecture and core components
• Data Types - Supported data types and usage
• TypeScript Examples - TypeScript usage examples
• Thrift Documentation - Thrift code generation and definitions
• SessionDataSet Guide - Iterator pattern for query results

Development

• Build Infrastructure - Build system analysis
• Debugging E2E Tests - E2E testing guide
• Test Database Reference - Test database setup

Project Information

• Project Status - Implementation status and roadmap

🔗 Quick Links

For Users

• New to IoTDB? Start with the Main README
• Using TypeScript? Check TypeScript Examples
• Querying data? See SessionDataSet Guide
• Need specific data types? See Data Types

For Contributors

• Want to contribute? Read Contributing Guidelines
• Building the project? See Build Infrastructure
• Running tests? Check Debugging E2E Tests

For Developers

• Understanding the code? Read Implementation Guide
• Working with Thrift? See Thrift Documentation
• Project roadmap? Check Project Status

📖 Documentation Structure

docs/
├── README.md                          # This file
├── implementation.md                  # Architecture & implementation
├── data-types.md                      # Data type reference
├── typescript-examples.md             # TypeScript usage
├── thrift.md                          # Thrift generation
├── project-status.md                  # Project status
└── development/                       # Development guides
    ├── build-infrastructure.md
    ├── debugging-e2e.md
    └── test-database.md

🚀 Additional Resources

• [GitHub Workflows]../.github/workflows/README.md) - CI/CD documentation
• Examples - Code examples and samples
• Apache IoTDB Documentation

📝 Contributing to Documentation

Found an error or want to improve the documentation? Please:

1. Check our Contributing Guidelines
2. Open an issue or submit a pull request
3. Follow the documentation style guide (keep it clear, concise, and helpful)

Last Updated: 2026-01-28