Welcome to the official documentation repository for Intuition — the world's first open, semantic, and decentralized knowledge graph. This repository contains comprehensive guides, API references, and developer resources for building with the trust protocol that's revolutionizing how we create, verify, and share knowledge online.
Live Documentation: docs.intuition.systems
- About Intuition
- Quick Start
- Documentation Structure
- Available Scripts
- What's in This Documentation
- For AI Agents
- Technology Stack
- Ecosystem Links
- Contributing
- License
Intuition is building a universal trust and identity layer for the decentralized web. At its core, Intuition creates an open, semantic knowledge graph that enables trustful interactions at scale through:
- Decoupling data from applications — Creating a universal data layer accessible across platforms
- Enabling verifiable claims — Making both objective facts and subjective opinions verifiable and incentive-aligned
- Providing semantic structure — Building rich, queryable relationships between any entities or concepts
- Incentivizing quality data — Using cryptoeconomic mechanisms to reward valuable contributions
We believe in a future where trust online is programmable, portable, and permissionless.
Intuition's knowledge graph is built on three fundamental primitives:
- Atoms — Universal identifiers for any entity (people, concepts, products, etc.)
- Triples — Semantic relationships expressing statements like "Subject → Predicate → Object"
- Signals — Community attestations that add weight and credibility to statements
These primitives work together to create a structured, queryable, and economically incentivized knowledge graph.
- Node.js >= 18.0 (< 25.0.0)
- npm or yarn package manager
- Git for version control
-
Clone the repository
git clone https://github.com/0xIntuition/intuition-docs.git cd intuition-docs -
Install dependencies
npm install
This will also automatically run
patch-packageto apply any necessary patches.
Start the development server with hot reload:
npm run devThe documentation site will be available at http://localhost:3000
Note: The
devscript runsdocusaurus start --no-opento start the server without automatically opening a browser.
Build the production-optimized site:
npm run buildPreview the production build locally:
npm run serveThe built site will be in the build/ directory.
This repository uses Docusaurus to generate a static documentation site. The documentation content is organized as follows:
intuition-docs/
├── docs/
│ └── _data/ # Main documentation content (routes to /docs/*)
│ ├── getting-started/ # Introduction and onboarding
│ ├── quick-start/ # Quick start guides
│ ├── intuition-sdk/ # SDK documentation and guides
│ ├── intuition-smart-contracts/ # Smart contracts documentation
│ ├── intuition-network/ # Network information and setup
│ ├── intuition-node/ # Node operation guides
│ ├── graphql-api/ # GraphQL API reference
│ ├── protocol/ # Protocol primitives and concepts
│ ├── intuition-concepts/ # Core concepts and architecture
│ ├── interaction-guide/ # How-to guides for common tasks
│ ├── tutorials/ # Step-by-step tutorials and use cases
│ ├── experimental-applications/ # Experimental integrations
│ └── resources/ # Glossary, FAQ, and community resources
├── src/ # Custom React components and styling
│ ├── components/ # Reusable UI components
│ ├── css/ # Custom CSS and Tailwind styles
│ └── pages/ # Custom pages
├── static/ # Static assets (images, files, etc.)
│ ├── img/ # Images and icons
│ └── llms-full.txt # LLM-optimized documentation
├── docusaurus.config.js # Docusaurus configuration
├── sidebars.js # Sidebar navigation configuration
└── package.json # Dependencies and scripts
How it works:
- Files in
docs/_data/are served at/docs/*routes - Example:
docs/_data/getting-started/overview.md→/docs/getting-started/overview - The sidebar navigation is auto-generated based on folder structure and frontmatter
| Script | Command | Description |
|---|---|---|
| Development | ||
npm run dev |
docusaurus start --no-open |
Start dev server without opening browser |
npm start |
docusaurus start |
Start dev server and open browser |
| Building | ||
npm run build |
docusaurus build |
Build production site |
npm run serve |
docusaurus serve |
Serve production build locally |
npm run clear |
docusaurus clear |
Clear Docusaurus cache |
| Code Quality | ||
npm run lint |
eslint . --ext .js,.ts,.jsx,.tsx |
Run ESLint |
npm run lint:fix |
npm run lint -- --fix |
Fix ESLint errors automatically |
npm run format |
prettier -w src docs |
Format code with Prettier |
npm run format:docs |
prettier -w docs |
Format only documentation files |
npm run typecheck |
tsc |
Run TypeScript type checking |
| Other | ||
npm run deploy |
docusaurus deploy |
Deploy to hosting |
npm run swizzle |
docusaurus swizzle |
Eject Docusaurus components |
Additional Commands:
# Check spelling in documentation
npx cspell docs/**/*.mdx
# Write translation files
npm run write-translations
# Write heading IDs
npm run write-heading-ids- Introduction — Learn about Intuition's vision and the problems it solves
- Getting Started — Choose your path and get onboarded
- Why Intuition? — Understand the challenges we're addressing
- Glossary — Master essential terminology and concepts
- Quick Start — Get up and running quickly
- Intuition SDK — TypeScript SDK documentation and guides
- Smart Contracts — Contract architecture and deployment information
- GraphQL API — Query the knowledge graph with powerful APIs
- Protocol Documentation — Working with primitives and core concepts
- Tutorials — Step-by-step guides and real-world examples
- Node Overview — Introduction to running an Intuition node
- Local Setup — Set up a node locally
- Kubernetes Deployment — Deploy nodes with Kubernetes
- Rust Backend — Understanding the Rust implementation
- Intuition Network — Network architecture and information
- Mainnet — Mainnet details
- Testnet — Testnet information
- RPC Endpoints — Network RPC endpoints
- Network Details — Chain IDs, contracts, and more
- Testnet Faucet — Get testnet tokens
- Interaction Guide — How-to guides for common operations
- Experimental Applications — Explore experimental integrations
- MCP Server — Model Context Protocol integration
- Farcaster Frames
- MetaMask Snap
- Data Populator
- FAQ — Frequently asked questions
- Community & Support — Get help and connect
This documentation is optimized for AI agent access with specialized formats:
- llms.txt — Concise documentation index for LLM consumption
- llms-full.txt — Complete documentation in LLM-friendly format
These files follow the llms.txt standard for AI-readable documentation.
This documentation site is built with:
- Docusaurus 3.9 — Modern static site generator with MDX support
- React 18 — UI components and interactivity
- TypeScript — Type safety and better developer experience
- Tailwind CSS — Utility-first styling
- Mermaid — Diagram generation in markdown
- Algolia — Powered search functionality
- GraphQL Sandbox — Interactive API exploration
- Intuition Website — Learn about the project and team
- Documentation — This documentation site (live)
- Protocol Explorer — Explore the knowledge graph
- Network Hub — Testnet development environment and tools
- Forum — Community discussions and support
- GitHub Organization — All open-source repositories
- Chrome Extension — Browser integration for the knowledge graph
We welcome contributions to improve our documentation! Whether you're fixing typos, adding examples, improving clarity, or creating new guides, your input helps make Intuition more accessible to everyone.
Ways to contribute:
- 🐛 Report issues or broken links
- 📝 Improve existing documentation
- ✨ Add new guides and tutorials
- 🌍 Help with translations
- 💡 Suggest new content
Please see our Contributing Guidelines for:
- How to submit pull requests
- Documentation style guide and standards
- Content review process
- Community guidelines
Quick contribution workflow:
- Fork this repository
- Create a feature branch:
git checkout -b docs/your-improvement - Make your changes and test locally with
npm run dev - Run linting and formatting:
npm run lint:fix && npm run format - Commit your changes with a descriptive message
- Push and create a pull request
This documentation is licensed under the terms specified in the LICENSE file.
Copyright © Intuition Systems Inc. since 2023. All rights reserved.
Ready to start building?