LogoLogo
  • Freedom Documentation
  • How to Write Good Docs
  • Architecture
    • App Structure
    • Module Structure
    • Tests Writing Standard
  • Processes
    • Creating a New Module
  • Store
    • [store] Freedom Syncable Store Functional Coverage
    • Synchronized File Store
    • CRDT
    • Cryptography
    • File System Encryption
    • Freedom Syncable Items - File System Example
    • Freedom Syncable Items
    • Permission Management
    • Synchronization
    • User-Facing File System
    • Vocabulary
Powered by GitBook

© 2025 Freedom Tech, Inc. All rights reserved. Freedom™ and Freedom Tech™ are trademarks of Freedom Tech, Inc.

On this page
  • What's Where
  • Top-Level Folders
  • Key Documents
  • How to Work With /docs
  • Supporters
Edit on GitHub
Export as PDF

Freedom Documentation

NextHow to Write Good Docs

Last updated 12 days ago

Welcome to the Freedom docs! This guide helps you navigate our documentation structure.

What's Where

Top-Level Folders

  • Architecture/ - System design, component relationships, and technical decisions

  • Processes/ - Business-process guidelines. Written for both people and AI-agents

  • [Feature Name]/ - Documentation for a specific feature

    • Store - Encrypted synchronized file store, the core of our system

    • Email - Encrypted email service

Key Documents

  • - Guidelines for contributing to documentation

  • [Feature Name]/! Start Here.md - Noticeable entry point, organized links to other docs

  • [Feature Name]/! FUNCTIONAL COVERAGE.md - Test planning and coverage tracking

How to Work With /docs

Open the folder with Obsidian. Recommended plugins:

  • Smart Typography

We use MDX format (Markdown with YAML metadata).

Supporters

Thank you to for hosting our docs at !

/How to Write Good Docs.md
GitBook
https://docs.FreedomTechHQ.com