Skip to content

About

A Rust-first document editor in development, designed for writing, formatting and everyday productivity.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

4 Commits

Folders and files

Repository files navigation

BreakFree Docs — document pages with a rainbow ribbon

BreakFree Docs

Your words. Your freedom.
An independent document editor in the making.
A place for letters, reports and ideas — part of BreakFree Office.

Status: planning Focus: documents Part of BreakFree Office

Vision · Roadmap · First milestone · Contribute · Office hub


Important

Planning stage — not a working editor yet. This repository contains original project documentation and approved branding. There are no installers or verified DOCX compatibility results. The roadmap describes proposed work, not shipped functionality.

Write without getting in your own way

BreakFree Docs is being planned for everyday writing and, over time, demanding document workflows. The aim is a dependable editor for letters, reports and long-form documents, with local files, clear controls and an extensible foundation.

Start with a small workflow that earns trust. Expand it through demonstrated results, not a list of buttons that do not work.

The first useful workflow

Create → Write → Format → Save → Reopen → Continue.

The first implementation milestone covers paragraphs, selection, basic emphasis and alignment, undo/redo, safe local persistence and unsaved-change handling. The first-milestone requirements remain the acceptance contract for this initial editor.

Where we are heading

Foundation Everyday documents Advanced workflows
Independent document model and command system Styles, lists, tables and images Comments and tracked changes
Unicode input and keyboard access Pagination, sections and headers Footnotes, references and equations
Undo, recovery and versioned persistence Search, navigation, print and PDF Templates, mail merge and automation
Tests that run without the interface A tested DOCX subset Optional assistant integrations

All items are planned. Advanced capabilities are separate milestones, not promises for the first release. Full compatibility with every Word feature is not an initial release requirement.

Built around the document

Your files stay under your control. Offline essentials, recoverable saves and explicit handling of unsupported content are design requirements. Imported macros and remote resources must not run or load silently.

The interface is not the engine. The proposed architecture separates the document model, editing operations, layout, storage and application shell. Desktop UI, command-line tools and future opt-in automation will use the same validated command interface.

Text and accessibility come first. Input methods, international text, keyboard navigation, screen-reader behavior and font fallback must influence architecture selection, not wait until the final polish stage.

A distinct member of one family. Docs has its own approved page icon, with the shared aubergine tile and rainbow ribbon expressing freedom and inclusion.

Roadmap and evidence

The detailed roadmap defines architecture proposals, feature areas, milestone dependencies, release gates, compatibility evidence and performance investigations. The suite development standard describes how progress must be reported.

DOCX support will be measured separately for reading, editing and writing. Text preservation, page layout, unsupported elements and font substitution need separate results. Opening one sample is not proof of general compatibility.

Development status

Area Current position
Identity and planning documents Available
Implementation language Rust-first proposal for review; not adopted yet
UI toolkit and native persistence format Selection and prototypes pending
Windows, macOS and Linux Intended evaluation targets; no supported builds
Application code, test results and releases Not available
License Owner decision pending

There is nothing to install yet. Reproducible build instructions will be published with a working implementation. Docs remains the first development priority within the suite.

The BreakFree family

Project Purpose
BreakFree Office Suite hub, identity and shared direction
BreakFree Docs Documents — you are here
BreakFree Sheets Spreadsheets and calculations
BreakFree Slides Presentations and visual storytelling

Get involved

Propose a writing workflow, accessibility improvement or technical experiment in Issues. Read CONTRIBUTING.md and AGENTS.md. Use synthetic documents, not customer data or private correspondence.

Everyone is welcome, including LGBTQ+ contributors and users. Follow the shared Code of Conduct.

License and independence

The software and brand-asset licenses remain owner decisions. Public visibility is not a grant of reuse rights. Third-party dependencies and assets must retain any required notices.

BreakFree Docs is an independent project, not affiliated with Microsoft. References to Word and DOCX describe intended workflows and interoperability goals, not endorsement or verified equivalence.


BreakFree Office · Your work. Your freedom.
Created by Anton Perchenko

About

A Rust-first document editor in development, designed for writing, formatting and everyday productivity.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors