Included all documents in the navigation

osborneMs · Apr 28, 2023 · b327cb0 · b327cb0
1 parent 2cd0d7d
commit b327cb0
Show file tree

Hide file tree

Showing 26 changed files with 144 additions and 121 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/contribution-guide-index.md b/docs/contribution-guide-index.md
@@ -1,3 +1,7 @@
+---
+id: contributing-to-morphir
+---
+
 #Contributing to the Morphir Ecosystem
 Morphir contains a few components for different aspects of the development process.
 These can be organized into the following:

diff --git a/docs/developer-guide-index.md b/docs/developer-guide-index.md
diff --git a/docs/installation-and-usage.md b/docs/installation-and-usage.md
@@ -1,3 +1,7 @@
+---
+id: installation-and-usage
+---
+
 #Morphir Tools Installation and Usage
 
 Morphir is provided as a set of command-line tools that are distribution through the NPM packaging system.

diff --git a/docs/json-schema-backend-config-test-plan.md b/docs/json-schema-backend-config-test-plan.md
@@ -1,3 +1,7 @@
+---
+id: json-schema-backend-test2
+---
+
 # Json SChema Backend Config Test Plan
 This document outlines the test plan for the 
 Json Schema backend initial configuration processing.

diff --git a/docs/json-schema-backend-testplan.md b/docs/json-schema-backend-testplan.md
@@ -1,3 +1,7 @@
+---
+id: json-schema-backend-test
+---
+
 # Json Schema Backend Test Specification
 This document speficies the testing strategy for the Json Schema backend.
 

diff --git a/docs/json-schema-config.md b/docs/json-schema-config.md
@@ -1,3 +1,7 @@
+---
+id: json-schema-config
+---
+
 # Json Schema Config Algorithm
 This a basic program execution flow algorithm that runs (for json-schema backend configuration) when a code
 generation command is issued:

diff --git a/docs/modelling-testing.md b/docs/modelling-testing.md
@@ -1,6 +1,6 @@
 ---
 id: morphir-testing-setup
-title: Setup
+title: Morphir Testing Setup
 ---
 
 # Testing Setup

diff --git a/docs/morpir-developers-guide.md b/docs/morpir-developers-guide.md
@@ -1,3 +1,8 @@
+
+---
+id:  morphir-developers-guide
+---
+
 # Morphir Developers' Guide
 The purpose of the document is to provide a detailed explanation of how various Morphir code artefacts work.
 It also documents the standard coding practices adopted for the Morphir project.

diff --git a/docs/scala-backend.md b/docs/scala-backend.md
@@ -1,3 +1,8 @@
+------
+id: scala-backend
+---
+
+
 # Scala Backend
 The Scala backend takes the Morphir IR as the input and returns an in-memory
 representation of files generated - FileMap

diff --git a/docs/scala-json-backend.md b/docs/scala-json-backend.md
diff --git a/docs/scala-json-codecs-backend.md b/docs/scala-json-codecs-backend.md
@@ -1,3 +1,8 @@
+---
+id: scala-codecs
+title: Scala Json Codecs Backend
+---
+
 # Scala JSON-Codecs Backend Documentation
 
 This document provides a description of the JSON codecs backend.

diff --git a/docs/spark-backend-api-documentation.md b/docs/spark-backend-api-documentation.md
@@ -1,3 +1,7 @@
+---
+id: spark-backend-api
+---
+
 # Spark Backend/API Documentation
 This is the entry point for the Spark Backend.
 

diff --git a/docs/spark-backend-as-a-special-case-of-a-relational-backend.md b/docs/spark-backend-as-a-special-case-of-a-relational-backend.md
@@ -1,3 +1,7 @@
+---
+id: spark-backend-relational
+---
+
 # Spark backend as a special case of a Relational backend
 
 ## Context and Problem Statement

diff --git a/docs/spark-backend-joins.md b/docs/spark-backend-joins.md
@@ -1,3 +1,7 @@
+---
+id: spark-backend-joins
+---
+
 # Spark Backend Joins
 Let's start by defining an example model that does some joins:
 

diff --git a/docs/spark-backend-optional-values.md b/docs/spark-backend-optional-values.md
@@ -1,3 +1,7 @@
+---
+id: spark-optional-values
+---
+
 # Handling optiobnal values in Spark
 
 Optional values are handled differently in SQL and Morphir. In SQL every value can potentially be `NULL` and there are implicit rules about how each operator should behave when `NULL`s are passed to them. Spark follows the same approach as documented in the [NULL semantics](https://spark.apache.org/docs/latest/sql-ref-null-semantics.html) section. Morphir on the other hand requires the modeler to handle missing values explicitly. 

diff --git a/docs/spark-testing-framework.md b/docs/spark-testing-framework.md
@@ -1,3 +1,7 @@
+---
+id: spark-testing-framework
+---
+
 # Spark Testing Framework
 ## Spark CSV Testing guide 
 The purpose of this document is to show how someone can use and edit the spark tests.

diff --git a/docs/spring-boot-readme.md b/docs/spring-boot-readme.md
@@ -1,3 +1,7 @@
+---
+id: springboot-generator
+---
+
 # SpringBoot Generator
 
 [Morphir](https://github.com/finos/morphir) is a multi-language system built on a data format that captures an 

diff --git a/docs/table-template.md b/docs/table-template.md
@@ -1,3 +1,7 @@
+---
+id: table-template
+---
+
 # Table Template
 |   Header col1  | Header col2  | Header col 3  |
 |:--------------:|:------------:|:--------------|

diff --git a/docs/testing-framework-readme.md b/docs/testing-framework-readme.md
@@ -1,3 +1,7 @@
+---
+id: testing-framework
+---
+
 # Testing Framework Guide
 The purpose of this document is how we can use Testing Framework within developer server.
 

diff --git a/docs/typescript.md b/docs/typescript.md
@@ -1,3 +1,7 @@
+---
+id: typescript-api
+---
+
 # TypeScript API
 
 The purpose of this document is describing the TypeScript API generated for Morphir

diff --git a/docs/user-guide-index.md b/docs/user-guide-index.md
diff --git a/docs/user-guide-readme.md b/docs/user-guide-readme.md
@@ -1,3 +1,7 @@
+---
+id: user-guide-readme
+---
+
 # Morphir Users' Guide
 
 Morphir's core purpose is to collect and store the vital business logic of an application. To fulfill that goal,

diff --git a/docs/whats-it-about.md b/docs/whats-it-about.md
@@ -1,5 +1,5 @@
 ---
-id: application-article
+id: what-is-it-about
 title: I Have an Application
 ---
 

diff --git a/docs/working-with-results-in-elm.md b/docs/working-with-results-in-elm.md
@@ -1,3 +1,8 @@
+---
+id: results-in-elm
+title: Working With Results in Elm
+---
+
 # Working With Results in Elm - With Morphir Examples
 This post explains the Result type in the Elm Programming Language and use cases in Morphir.
 

diff --git a/website/sidebars.js b/website/sidebars.js
@@ -27,12 +27,26 @@ const sidebars = {
     {
       type: 'category',
       label: 'Overview',
-      items: ['intro', 'application-article', 'domain-model', 'modeling-entire-application'],
+      items: [
+          'intro',
+          'morphir-entail',
+          'what-is-it-about',
+          'domain-model',
+          'model-versioning',
+          'modeling-entire-application',
+          'modeling-database-developers',
+          'modeling-financial-concepts'
+      ],
     },
     {
       type: 'category',
       label: 'Getting Started',
-      items: ["installation",  "editor-setup"]
+      items: [
+          "installation",
+          "editor-setup",
+          'morphir-testing-setup',
+          'installation-and-usage'
+      ]
     },
     {
       type: 'category',
@@ -43,11 +57,31 @@ const sidebars = {
       type: 'category',
       label: 'Integration Guides',
       items: [
+          'scala-backend',
+          'scala-codecs',
+          'codec-docs',
+          'generate-scala-test-case',
           'morphir-spark',
+          'spark-backend-api',
+          'spark-testing-framework',
+          'spark-optional-values',
+          'spark-backend-joins',
+          'spark-backend-relational',
           'morphir-cadl-mapping',
           'insight-api-guide',
           'morphir-typescript',
-          'relational-backend'
+          'typescript-api',
+          'relational-backend',
+          'springboot-generator',
+          'json-schema-sample',
+          'json-schema-mappings',
+          'json-schema-enabled-decorator',
+          'json-schema-config',
+          'json-schema-backend-test',
+          'json-schema-backend-test2',
+          'json-codecs-doc',
+          'decorations-users-guide',
+          'custom-attributes-users-guide'
       ]
     },
     {
@@ -57,6 +91,8 @@ const sidebars = {
           'modeling-database-developers',
           'modeling-financial-concepts',
           'publishing-elm-package',
+          'morphir-quick-start',
+          'generating-json-schema',
         {
           type: 'link',
           label: 'Surfing Board Tutorial',
@@ -67,7 +103,12 @@ const sidebars = {
     {
       type: 'category',
       label: 'Contribution Guide',
-      items: ['code-of-conduct', 'contribution-guide', 'contribution-and-governance-policies']
+      items: [
+          'code-of-conduct',
+          'contribution-guide',
+          'contribution-and-governance-policies',
+          'contributing-to-morphir'
+      ]
     },
     {
       type: 'category',
@@ -77,7 +118,23 @@ const sidebars = {
     {
       type: 'category',
       label: 'Further Readings',
-      items: ['dev-bots', 'cli-cli2-merging']
+      items: [
+          'functional-programming',
+          'dev-bots',
+          'cli-cli2-merging',
+          'results-in-elm',
+          'user-guide-readme',
+          'testing-framework',
+          'table-template',
+          'automating-regtech',
+          'morphir-elm-commands-processing',
+          'morphir-community',
+          'adr-for-morphir-cli',
+          'media-about-morphir',
+          'soul-application',
+          'error-append-not-supported',
+          'command-line-tools'
+      ]
     }
   ],