Refactoring docs

- Move `api` docs under `docs/web`. - Fix some links in the docs.
iGN5117 · Mar 28, 2019 · 3d5c289 · 3d5c289
1 parent c016f8a
commit 3d5c289
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -247,7 +247,7 @@ If you have Clang `3.7` installed you might see the following warning message:
 
 * [False Positives](analyzer/false_positives.md)
 * [Checker and Static Analyzer configuration](analyzer/checker_and_analyzer_configuration.md)
-* [Checker documentation](analyzer/checker_docs.md)
+* [Checker documentation](web/checker_docs.md)
 * [GCC incompatibilities](analyzer/gcc_incompatibilities.md)
 
 ## Security configuration

diff --git a/docs/deps.md b/docs/deps.md
@@ -48,4 +48,5 @@ update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy
 
 ## PostgreSQL
 
-For the additional PostgreSQL dependencies see the [PostgreSQL setup](postgresql_setup.md) documentation.
+For the additional PostgreSQL dependencies see the
+[PostgreSQL setup](web/postgresql_setup.md) documentation.
diff --git a/docs/usage.md b/docs/usage.md
@@ -303,7 +303,7 @@ version of the same source file.
   would introduce any new issues.
 * Store daily runs of a module every day in a new run post-fixed with date.
 * You can query *new* and *resolved* bugs using the
-  [`cmd diff`](user_guide.md#show-differences-between-two-runs-diff) or the
+  [`cmd diff`](web/user_guide.md#show-differences-between-two-runs-diff) or the
   Web GUI.
 * Programmers should use
   [in-code-suppression](web/user_guide.md#source-code-comments)

diff --git a/docs/api/README.md → docs/web/api/README.md b/docs/api/README.md → docs/web/api/README.md
diff --git a/docs/web/permissions.md b/docs/web/permissions.md
@@ -113,7 +113,7 @@ to `A`.
 
 # Available permissions <a name="available-permissions"></a>
 
-> Developer guide: See the [API documentation](../api/README.md) for the list of
+> Developer guide: See the [API documentation](api/README.md) for the list of
 > permissions and which API call requires which permission exactly.
 
 ## Server-wide (global) permissions <a name="global-permissions"></a>

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,5 +9,6 @@ docs_dir: 'docs'
 nav:
   - Home: README.md
   - 'Quick Howto': usage.md
-  - 'User Guide': user_guide.md
+  - 'Analyzer User Guide': analyzer/user_guide.md
+  - 'Web User Guide': web/user_guide.md