| # Documentation Index |
| |
| This directory contains comprehensive documentation for the Apache IoTDB Node.js client. |
| |
| ## 📚 Documentation Categories |
| |
| ### Getting Started |
| - [Main README](../README.md) - Project overview, installation, and quick start |
| - [Contributing Guidelines](../CONTRIBUTING.md) - How to contribute to the project |
| - [Changelog](../CHANGELOG.md) - Version history and release notes |
| |
| ### API & Usage |
| - [Implementation Guide](implementation.md) - Architecture and core components |
| - [Data Types](data-types.md) - Supported data types and usage |
| - [TypeScript Examples](typescript-examples.md) - TypeScript usage examples |
| - [Thrift Documentation](thrift.md) - Thrift code generation and definitions |
| - [SessionDataSet Guide](sessiondataset-guide.md) - Iterator pattern for query results |
| |
| ### Development |
| - [Build Infrastructure](development/build-infrastructure.md) - Build system analysis |
| - [Debugging E2E Tests](development/debugging-e2e.md) - E2E testing guide |
| - [Test Database Reference](development/test-database.md) - Test database setup |
| |
| ### Project Information |
| - [Project Status](project-status.md) - Implementation status and roadmap |
| |
| ## 🔗 Quick Links |
| |
| ### For Users |
| - **New to IoTDB?** Start with the [Main README](../README.md) |
| - **Using TypeScript?** Check [TypeScript Examples](typescript-examples.md) |
| - **Querying data?** See [SessionDataSet Guide](sessiondataset-guide.md) |
| - **Need specific data types?** See [Data Types](data-types.md) |
| |
| ### For Contributors |
| - **Want to contribute?** Read [Contributing Guidelines](../CONTRIBUTING.md) |
| - **Building the project?** See [Build Infrastructure](development/build-infrastructure.md) |
| - **Running tests?** Check [Debugging E2E Tests](development/debugging-e2e.md) |
| |
| ### For Developers |
| - **Understanding the code?** Read [Implementation Guide](implementation.md) |
| - **Working with Thrift?** See [Thrift Documentation](thrift.md) |
| - **Project roadmap?** Check [Project Status](project-status.md) |
| |
| ## 📖 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](../examples/) - Code examples and samples |
| - [Apache IoTDB Documentation](https://iotdb.apache.org/UserGuide/Master/API/Programming-NodeJS-Native-API.html) |
| |
| ## 📝 Contributing to Documentation |
| |
| Found an error or want to improve the documentation? Please: |
| |
| 1. Check our [Contributing Guidelines](../CONTRIBUTING.md) |
| 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 |
