Official documentation for Fhenix - the privacy-preserving blockchain platform that enables developers to build confidential smart contracts using Fully Homomorphic Encryption (FHE).
This repository contains the complete developer documentation for Fhenix, including:
- Getting Started - Introduction to Fhenix, compatibility guides, and builder support
- Cofhejs - JavaScript library for client-side encryption, permit management, and decryption
- FHE Library - Solidity library for working with encrypted data in smart contracts
- Tutorials - Step-by-step guides for building FHE-enabled applications
- Deep Dive - Technical architecture details, CoFHE components, and data flows
This documentation is built using Mintlify. To preview the documentation locally:
Install the Mintlify CLI:
npm i -g mintRun the following command at the root of the documentation directory:
mint devThe documentation will be available at http://localhost:3000.
fhenix-developer-docs/
├── get-started/ # Introduction and getting started guides
├── cofhejs/ # Client-side encryption library docs
├── fhe-library/ # Solidity FHE library documentation
├── tutorials/ # Step-by-step tutorials
├── deep-dive/ # Architecture and technical deep dives
├── api-reference/ # API reference documentation
└── docs.json # Mintlify configuration
Changes pushed to the default branch are automatically deployed to production through the Mintlify GitHub app integration.
We welcome contributions to improve the documentation. When making changes:
- Test locally using
mint dev - Ensure all links and navigation work correctly
- Follow the existing documentation style and structure
- Submit a pull request with a clear description of your changes
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI - If a page loads as a 404: Make sure you are running in the folder with
docs.json
For questions and support:
- Join our Telegram Support Channel
- Visit our Discord
- Check the Support and Feedback documentation