Add editor, codebase, and design documentation

This commit is contained in:
Keavon Chambers
2021-03-27 02:26:55 -07:00
parent d20042bdd6
commit 808b116037
7 changed files with 481 additions and 0 deletions
+13
View File
@@ -0,0 +1,13 @@
# Graphite project documentation
## [Graphite editor manual](editor/index.md)
Click above for the Graphite editor manual. This will evolve into the official manual for the Graphite editor. It contains documentation for each feature of Graphite focused on both usage instructions and technical details.
## [Graphite codebase docs](codebase/index.md)
Click above for the Graphite codebase docs. This is meant as a good starting point for new developers to jump into the Graphite codebase. It aims to explain the architecture, code structure, and other useful details.
## [Graphite design notes](design/index.md)
Click above for the Graphite design notes. This is a collection of notes and ideas pertaining to the user experience, workflow, and UI design of Graphite. It should aim to be mostly up-to-date and reflect the current state of understanding of the design for relatively finalized features, but in-progress feature designs may contain ideas, concepts, and proposals.