summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/dev/getting-started.md16
-rw-r--r--docs/dev/ot.md6
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md
new file mode 100644
index 00000000..6eb1b136
--- /dev/null
+++ b/docs/dev/getting-started.md
@@ -0,0 +1,16 @@
+# Developer Notes
+
+## Structure
+
+```text
+codimd/
+├── test/ --- test suite
+├── docs/ --- documentation
+├── lib/ --- server libraries
+└── public/ --- client files
+ ├── css/ --- css styles
+ ├── docs/ --- default documents
+ ├── js/ --- js scripts
+ ├── vendor/ --- vendor includes
+ └── views/ --- view templates
+```
diff --git a/docs/dev/ot.md b/docs/dev/ot.md
new file mode 100644
index 00000000..71f7f78d
--- /dev/null
+++ b/docs/dev/ot.md
@@ -0,0 +1,6 @@
+## Operational Transformation
+
+From 0.3.2, we started supporting operational transformation.
+It makes concurrent editing safe and will not break up other users' operations.
+Additionally, now can show other clients' selections.
+See more at [http://operational-transformation.github.io/](http://operational-transformation.github.io/)