diff options
author | Claudius | 2019-03-31 20:10:32 +0200 |
---|---|---|
committer | Claudius | 2019-04-01 01:03:36 +0200 |
commit | 54edec89000aec94cae325be3d5c85442ac21adf (patch) | |
tree | 700b588b4a5d3682ff6fdb36ea0f4281bbf8d82d /docs/dev | |
parent | 74fdd26ea057dab77e761614497d69d2c90a66d7 (diff) |
striving for consistency across various docs
Signed-off-by: Claudius <opensource@amenthes.de>
Diffstat (limited to '')
-rw-r--r-- | docs/dev/getting-started.md | 10 | ||||
-rw-r--r-- | docs/dev/ot.md | 12 | ||||
-rw-r--r-- | docs/dev/webpack.md | 9 |
3 files changed, 23 insertions, 8 deletions
diff --git a/docs/dev/getting-started.md b/docs/dev/getting-started.md index 79a97d4a..07524971 100644 --- a/docs/dev/getting-started.md +++ b/docs/dev/getting-started.md @@ -1,12 +1,12 @@ -# Developer Notes +Developer Notes +=== ## Preparing for running the code -**Notice:** *If you're into [docker](../setup/docker.md) or [heroku](../setup/heroku.md), -there's extra documents for those!* +**Notice:** *There's [specialised instructions for docker](../setup/docker.md) or [heroku](../setup/heroku.md), if you prefer running code this way!* -1. Clone the repository (Cloning is the preferred way, but you can also download - and unzip a release) +1. Clone the repository with `git clone https://github.com/codimd/server.git codimd-server` + (cloning is the preferred way, but you can also download and unzip a release) 2. Enter the directory and run `bin/setup`, which will install npm dependencies and create configs. The setup script is written in Bash, you would need bash as a prerequisite. diff --git a/docs/dev/ot.md b/docs/dev/ot.md index 71f7f78d..924be693 100644 --- a/docs/dev/ot.md +++ b/docs/dev/ot.md @@ -1,6 +1,14 @@ -## Operational Transformation +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/) + +See more at [https://operational-transformation.github.io/](https://operational-transformation.github.io/) + +And even more in this 2010 article series: + +* https://drive.googleblog.com/2010/09/whats-different-about-new-google-docs_21.html +* https://drive.googleblog.com/2010/09/whats-different-about-new-google-docs_22.html +* https://drive.googleblog.com/2010/09/whats-different-about-new-google-docs.html diff --git a/docs/dev/webpack.md b/docs/dev/webpack.md index 7b391f3a..b05fd1d3 100644 --- a/docs/dev/webpack.md +++ b/docs/dev/webpack.md @@ -1,4 +1,11 @@ -# Webpack Docs +Webpack +=== + +Webpack is a JavaScript build system for frontend code. You can find out all +about it on [the webpack website](https://webpack.js.org/). + +Here's how we're using it: + ## `webpack.common.js` This file contains all common definition for chunks and plugins, that are needed by the whole app. |