From 6c49e182f2611378c19f85136884cbfcf24f70d9 Mon Sep 17 00:00:00 2001
From: "G. Ann Campbell" <ann.campbell@sonarsource.com>
Date: Thu, 25 Apr 2019 12:08:53 -0400
Subject: Update README.md
---
server/sonar-docs/static/README.md | 38 +++++++++++++++++++++++++++++++++++---
1 file changed, 35 insertions(+), 3 deletions(-)
(limited to 'server/sonar-docs')
diff --git a/server/sonar-docs/static/README.md b/server/sonar-docs/static/README.md
index 4e3c36aa6a7..a82633b958c 100644
--- a/server/sonar-docs/static/README.md
+++ b/server/sonar-docs/static/README.md
@@ -1,13 +1,45 @@
These three `*.NavigationTree.json` files control the navigation trees of the three versions of the documentation.
-Each one contains a JSON array. Array elements may either be:
+Each one contains a JSON array.
+
+**Array elements may either be:**
* a path string
* a node
-**Nodes contain two elements:**
+**Nodes contain two elements:**
* title - string. This is the "parent" node name to be used in the navigation tree
-* children - array of path strings
+* children - array
+
+**Children may either be:**
+* path string
+* node
+
+e.g.
+```
+ {
+ "title": "Analyzing Source Code",
+ "children": [
+ "/analysis/overview/",
+ "/analysis/analysis-parameters/",
+ "/analysis/coverage/",
+ "/analysis/external-issues/",
+ "/analysis/background-tasks/",
+ "/analysis/generic-issue/",
+ "/analysis/generic-test/",
+ "/analysis/pull-request/",
+ {
+ "title": "Sub child",
+ "children": [
+ "/analysis/supported-languages/",
+ {
+ "title": "Sub sub child",
+ "children": ["/analysis/background-tasks/"]
+ }
+ ]
+ }
+```
+
**Paths**
* begin with '/'
--
cgit v1.2.3