This repository contains the documentation site for Uniteum, built with Jekyll and hosted on GitHub Pages.
The main documentation is organized as:
- index.md - Homepage
- getting-started.md - Quick start guide
- economics-of-one.md - The "1" token value hypothesis
- use-cases.md - What you can build
- safety.md - Risks and disclaimers
- known-issues.md - Version history and bug reporting
- legal.md - Legal notices
- license.md - Licensing information
Additional documentation is organized under:
/concepts/- Core concepts and mechanics/reference/- Technical reference and contract details/research/- Research papers and theoretical foundations
_config.yml- Jekyll site configuration_data/- Contract addresses, navigation, and other data files_includes/- Reusable templates and components_layouts/- Page layoutsassets/- Images, CSS, and other static assets
Meta Documents (Collaboration & Development)
These documents support our development process and collaboration with Claude. They're organized in the .meta/ directory but aren't part of the user-facing documentation.
- CLAUDE.md - Main instructions for Claude Code - Project overview, conventions, and guidelines (kept at root)
- .meta/STYLE_GUIDE.md - Writing style and formatting standards
- .meta/CONTRACT_REFERENCES.md - How contract addresses are referenced in docs
- .meta/ENV_INTEGRATION.md - Environment setup and Jekyll integration
- .meta/SCRIPTS_SUMMARY.md - Available scripts and their usage
- .meta/EXAMPLE_UNITS_SUMMARY.md - Catalog of example units used across docs
- .meta/SETUP_SUMMARY.md - Site setup and initialization details
- .meta/DUPLICATION_AUDIT.md - Content duplication analysis
- .meta/DEDUPLICATION_SUMMARY.md - Deduplication actions taken
- .meta/REFACTORING_SUMMARY.md - Major refactoring decisions
# Install dependencies
bundle install
# Run local server
bundle exec jekyll serve
# Build site
bundle exec jekyll buildThe site will be available at http://localhost:4000.
The site is automatically deployed to GitHub Pages when changes are pushed to the main branch.
Live site: uniteum.one → uniteum.github.io