summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Kämmerle <andreas.kaemmerle@gmail.com>2018-08-02 22:51:04 +0200
committerToon Claes <toon@gitlab.com>2019-05-02 11:51:06 +0200
commit0a08fb3cd1f3ce76e384cd0b573297dd4f74fa43 (patch)
tree0336f86d67306bf788db514185339d007de8f7c0
parent743508bfa5f19b201790f14648667eb38e255282 (diff)
downloadgitlab-ce-improve-wiki-custom-sidebar-docs.tar.gz
Improved custom wiki sidebar docsimprove-wiki-custom-sidebar-docs
-rw-r--r--doc/user/project/wiki/index.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md
index 95f606fd786..e3c6cd6d6ff 100644
--- a/doc/user/project/wiki/index.md
+++ b/doc/user/project/wiki/index.md
@@ -116,7 +116,9 @@ instructions.
## Customizing sidebar
-By default, the wiki would render a sidebar which lists all the pages for the
-wiki. You could as well provide a `_sidebar` page to replace this default
-sidebar. When this customized sidebar page is provided, the default sidebar
-would not be rendered, but the customized one.
+On the project's Wiki page, there is a right side navigation that renders the full Wiki pages list by default, with hierarchy.
+
+If the Wiki repository contains a `_sidebar` page, the file of this page replaces the default side navigation.
+This custom file serves to render it's custom content, fully replacing the standard sidebar.
+
+Support for displaying a generated TOC with a custom side navigation is planned.