Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

TOM — Team-Oriented Markdown

A Git client specialized in documentation. Your markdown files, your Git repository, and a UI that makes that workflow pleasant for an entire team — no mandatory cloud, no lock-in, no subscription.

Documentation map

Five folders, one question each, plus the decision log that cuts across them.

Folder Answers Contents
products/ what each feature must do, for stakeholders convention — one folder per feature: doc.md (non-technical rules) + mocks/
product/ what is being built, and why product · roadmap
architecture/ how it is built layers · flows · domain model · dependencies
design/ what the composite screens and the visual system look like wireframes · visual language
process/ how the work is done setup · versioning · repository settings
decisions/ what was settled, and why ADRs, one per file, declaratively named

docs/products/ is the one folder meant to be edited by stakeholders, not just engineers: it is the living source of truth for app behaviour, kept current as the app evolves, and is what code should be checked against. product/ stays the "why" — vision, personas, non-goals — one level above any single feature. decisions/ sits outside all of them on purpose: 001 is about licensing, 004 about the business model, 013 about the stack. They belong to no single folder, and keeping the log flat is the ADR convention.

Decisions at a glance

# Decision
001 License is MIT
002 Git through the system binary (libgit2 later)
003 The editor is source + preview; no WYSIWYG
004 The business model is open-core
005 Errors use Result with sealed classes; no dartz
006 No navigation package
007 External dependencies isolated behind contracts
008 Monorepo with a pure Dart core (partly superseded by 014)
009 The space session is the single source of truth
010 The watcher and git cooperate by an explicit protocol
011 Telemetry is opt-in, no-op by default
012 The shell is extensible through compile-time modules
013 The stack is Flutter and Dart
014 Each layer is its own package
015 DDD is applied selectively

Where the code is

The Dart workspace lives in src/, so this folder and the licence lead the repository root rather than build files. Seven packages, one per layer; make help from the root lists every command.


This documentation lives in docs/ inside the repo itself, as markdown — the app should, as soon as possible, be used to edit its own docs.