Skip to main content
This documentation is organized to help you find information quickly, whether you’re new to zero-knowledge technology or an experienced developer.

​
How To Use This Documentation

  1. Introduction Section: Start here if you’re new to zkTerm. The introduction provides an overview of what zkTerm does, its key features, real-world applications, and the basic concepts behind zero-knowledge technology. Read these pages first to understand the fundamentals.
  2. Getting Started Section: Once you understand the basics, this section helps you begin using zkTerm. Architecture Overview explains how the system is built and how components interact. Use this as reference when you need to understand technical details.
  3. ZK Ecosystem Section: Deep dives into each zkTerm component - zkID for identity, zkCompression for private transfers, zkToolkit for cryptographic primitives, zkStorage for encrypted files, and zkAuth for passwordless authentication. Read the specific pages relevant to your use case.
  4. Guides Section: Step-by-step tutorials for common tasks. These are practical, hands-on walkthroughs that show you how to accomplish specific goals. Follow along with the terminal commands and code examples.
  5. API Reference Section: Technical documentation for developers integrating zkTerm into their applications. Each API endpoint is documented with request/response formats, parameters, and example usage.
  6. Resources Section: FAQ answers common questions. Troubleshooting helps debug issues. Security explains our approach to protecting your data. Changelog tracks updates and new features.
  7. Search Function: Use the search bar at the top to find specific topics quickly. Search works across all documentation pages and is the fastest way to find information on a specific command or feature.
  8. Code Examples: Throughout the documentation, you’ll find code blocks with example commands and snippets. These are designed to be copied and used directly - just replace placeholder values with your own data.
  9. Feedback: Each page has feedback options at the bottom. Let us know if documentation is unclear or if you find errors. Your feedback helps improve these docs for everyone.
  10. External Links: Links to GitHub for source code and issue tracking, and X (Twitter) for updates and announcements. These are your primary channels for community interaction and support.