From 2ff91cc0151d7cf3b3a81ecf699142ddb3ad8656 Mon Sep 17 00:00:00 2001 From: janat08 Date: Thu, 13 Jun 2019 07:07:28 +0600 Subject: [PATCH] contrib/doc edit --- README.md | 7 ++++--- website/docs/README.md | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4539aa2d..0990bad3 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,10 @@ Are you looking for the v3 docs? See [here](https://v3.docute.org). 1. Fork it! 2. Create your feature branch: `git checkout -b my-new-feature` -3. Commit your changes: `git commit -am 'Add some feature'` -4. Push to the branch: `git push origin my-new-feature` -5. Submit a pull request :D +3. Start dev: `npm run website` +4. Commit your changes: `git commit -am 'Add some feature'` +5. Push to the branch: `git push origin my-new-feature` +6. Submit a pull request :D ## Author diff --git a/website/docs/README.md b/website/docs/README.md index 68d9d3eb..ce320310 100644 --- a/website/docs/README.md +++ b/website/docs/README.md @@ -10,7 +10,7 @@ It's totally runtime-driven so there's no server-side components involved which ## How does it work -In short: URL is the API. +In short: URL is the [API](./options.md#sourcepath). We fetch and render corresponding markdown file for the URL you visit: