More clarifications

xtyuns · Aug 18, 2020 · af23d48 · af23d48
1 parent 1bbb9c5
commit af23d48
Showing 1 changed file with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-A [docusaurus](https://docusaurus.io/en/) site that powers [docs.getdbt.com](https://docs.getdbt.com/).
+A [docusaurus](https://v2.docusaurus.io/) site that powers [docs.getdbt.com](https://docs.getdbt.com/).
 
 ## Branching
 
@@ -14,11 +14,16 @@ We welcome contributions from community members to this repo:
 
 If you are contributing significant changes, it may be worth setting up the repo to run locally, as follows:
 1. Ensure node is installed: `brew install node`
-2. Clone this repo: `[email protected]:fishtown-analytics/dbt.git`
-3. `cd` into the `website` subdirectory
+2. Clone this repo: `git clone [email protected]:fishtown-analytics/docs.getdbt.com.git`
+3. `cd` into the repo: `cd docs.getdbt.com`
+3. And then `cd` into the `website` subdirectory: `cd website`
 4. Install the required node packages: `npm install`
 5. Build the website: `npm start`
-6. Before pushing your changes to a branch, check that all links work by using the `make build` script
+6. Before pushing your changes to a branch, check that all links work by using the `make build` script.
+
+You can also check out [this Loom video](https://www.loom.com/share/7037780b86eb4f16953664b8f15f1e21) that I recorded for co-workers — it covers setting up docs.getdbt.com locally, and adding a page with links and images. Heads up — this was very much something I did on the fly, so is not super polished!
 
 ## Custom components
 Check out [docs.getdbt.com/styles](https://docs.getdbt.com/styles) for examples of different components that can be used in these docs.
+
+You can also use components directly from the [docusaurus library](https://v2.docusaurus.io/docs/markdown-features/).