GitBook: [#28] Misisng link fixed

ClimateMind · Oct 16, 2022 · 15d2a43 · 15d2a43
1 parent 294f1b2
commit 15d2a43
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/docs/README.md → README.md b/docs/README.md → README.md
@@ -26,4 +26,4 @@ Other ways to contribute to the project are listed [here](https://contribute.cli
 
 ## How to report bugs or suggest features?
 
-See our [report bug](contribute-as-a-python-dev/report-bug.md) and [suggest feature](contribute-as-a-python-dev/suggest-feature.md) pages for more information.
+See our [report bug](docs/contribute-as-a-python-dev/report-bug.md) and [suggest feature](docs/contribute-as-a-python-dev/suggest-feature.md) pages for more information.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,6 +1,6 @@
 # Table of contents
 
-* [ClimateMind REST API](docs/README.md)
+* [ClimateMind REST API](README.md)
 * [Under the hood](docs/under-the-hood.md)
 * [🐍 Contribute as a Python dev](docs/contribute-as-a-python-dev/README.md)
   * [Installation](docs/contribute-as-a-python-dev/installation.md)

diff --git a/...ython-dev/how-to-update-docs/documentation/how-to-change-the-developer-guide.md b/...ython-dev/how-to-update-docs/documentation/how-to-change-the-developer-guide.md
@@ -37,7 +37,8 @@ Managing the documentation with GitBook could be handy but sometimes lead to som
 * all `.md` files should be located in `docs` folder
 * there are no invalid paths like `docs/docs/docs...` in the `SUMMARY.md` file
 * files are not duplicated
-* change that links are not pointing to `app.gitbook.com`
+* check that links in `.md` files are not pointing to `app.gitbook.com`
+* check that links in `.md` files are pointing to existing pages.
 
 ## Any other way
 

diff --git a/...e-as-a-python-dev/how-to-update-docs/documentation/how-to-merge-docs-changes.md b/...e-as-a-python-dev/how-to-update-docs/documentation/how-to-merge-docs-changes.md
@@ -5,10 +5,10 @@ When changes are in `docs` branch they could be merged to `develop` branch. &#x2
 1. Create a Push Request from `develop` <- `docs`.
 2.  Update with rebase `docs` branch using UI in PR.&#x20;
 
-    <figure><img src="../../../.gitbook/assets/Screenshot 2022-10-13 at 13.34.00.png" alt=""><figcaption><p>Update the docs branch</p></figcaption></figure>
+    <figure><img src="../../../../.gitbook/assets/Screenshot 2022-10-13 at 13.34.00.png" alt=""><figcaption><p>Update the docs branch</p></figcaption></figure>
 3.  Create a simple merge commit, **without** squash or rebase.
 
-    <figure><img src="../../../.gitbook/assets/Screenshot 2022-10-13 at 13.09.53.png" alt=""><figcaption><p>Merge docs to develop using simple merge</p></figcaption></figure>
+    <figure><img src="../../../../.gitbook/assets/Screenshot 2022-10-13 at 13.09.53.png" alt=""><figcaption><p>Merge docs to develop using simple merge</p></figcaption></figure>
 
 The final git tree will look like this. GitBook should be able to handle it without any issues.&#x20;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ Other ways to contribute to the project are listed [here](https://contribute.cli

		## How to report bugs or suggest features?

		See our [report bug](contribute-as-a-python-dev/report-bug.md) and [suggest feature](contribute-as-a-python-dev/suggest-feature.md) pages for more information.
		See our [report bug](docs/contribute-as-a-python-dev/report-bug.md) and [suggest feature](docs/contribute-as-a-python-dev/suggest-feature.md) pages for more information.