diff options
| author | Claudius | 2019-03-31 16:02:05 +0200 |
|---|---|---|
| committer | Claudius | 2019-04-01 01:03:36 +0200 |
| commit | edf301cfa320cce48eaf055a57f416bc1aa6ee1e (patch) | |
| tree | 34e583fedcbce75bb3d4409cc5e21b3c18226b9f /docs/dev | |
| parent | 3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff) | |
splitting README.md into files in /docs for better readability
Signed-off-by: Claudius <opensource@amenthes.de>
Diffstat (limited to '')
| -rw-r--r-- | docs/dev/getting-started.md | 16 | ||||
| -rw-r--r-- | docs/dev/ot.md | 6 |
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/) |