diff --git a/doc/dependencies.md b/doc/dependencies.md index 57e93c5..d952045 100644 --- a/doc/dependencies.md +++ b/doc/dependencies.md @@ -13,4 +13,4 @@ with `brew install coreutils`, to get a working version of `realpath`. ## Host Environment -The Overleaf toolkit is tested on Ubuntu Linux, but we expect that most modern Linux systems will be able to run the toolkit without problems. Although it is possible to run the toolkit on other platforms, they are not officially supported. +The Overleaf Toolkit is tested on Ubuntu Linux, but we expect that most modern Linux systems will be able to run the toolkit without problems. Although it is possible to run the toolkit on other platforms, they are not officially supported. diff --git a/doc/docker-compose.md b/doc/docker-compose.md index baf741e..7865a44 100644 --- a/doc/docker-compose.md +++ b/doc/docker-compose.md @@ -1,6 +1,6 @@ # Working with Docker-Compose Services -The Overleaf toolkit runs Overleaf inside a docker container, plus the +The Overleaf Toolkit runs Overleaf inside a docker container, plus the supporting databases (MongoDB and Redis), in their own containers. All of this is orchestrated with `docker-compose`. diff --git a/doc/persistent-data.md b/doc/persistent-data.md index 85e7503..171e578 100644 --- a/doc/persistent-data.md +++ b/doc/persistent-data.md @@ -1,6 +1,6 @@ # Persistent Data Overview -The Overleaf toolkit needs to store persistent data, such as the files required to compile LaTeX projects, and the contents of the MongoDB database. This is achieved by mounting a few directories from the host machine into the docker containers, and writing the data to those directories. +The Overleaf Toolkit needs to store persistent data, such as the files required to compile LaTeX projects, and the contents of the MongoDB database. This is achieved by mounting a few directories from the host machine into the docker containers, and writing the data to those directories. ## Data Directories diff --git a/doc/quick-start-guide.md b/doc/quick-start-guide.md index d5cd555..ecd4978 100644 --- a/doc/quick-start-guide.md +++ b/doc/quick-start-guide.md @@ -2,7 +2,7 @@ ## Prerequisites -The overleaf toolkit depends on the following programs: +The Overleaf Toolkit depends on the following programs: - bash - docker @@ -76,7 +76,7 @@ These are the three configuration files you will interact with: ## Starting Up -The overleaf toolkit uses `docker-compose` to manage the overleaf docker containers. The toolkit provides a set of scripts which wrap `docker-compose`, and take care of most of the details for you. +The Overleaf Toolkit uses `docker-compose` to manage the overleaf docker containers. The toolkit provides a set of scripts which wrap `docker-compose`, and take care of most of the details for you. Let's start the docker services: diff --git a/doc/the-doctor.md b/doc/the-doctor.md index b04f72c..14cc836 100644 --- a/doc/the-doctor.md +++ b/doc/the-doctor.md @@ -1,6 +1,6 @@ # The Doctor -The Overleaf toolkit comes with a handy `doctor` script, to help with debugging. Just run `bin/doctor` and the script will print out information about your host environment, your configuration, and the dependencies the toolkit needs. This output can also help the Overleaf support team to help you figure out what has gone wrong, in the case of a Server Pro installation. +The Overleaf Toolkit comes with a handy `doctor` script, to help with debugging. Just run `bin/doctor` and the script will print out information about your host environment, your configuration, and the dependencies the toolkit needs. This output can also help the Overleaf support team to help you figure out what has gone wrong, in the case of a Server Pro installation. ## Getting Help