Levelled up documentation in Morphir repo

osborneMs · Apr 17, 2023 · 4d60024 · 4d60024
1 parent 791817c
commit 4d60024
Show file tree

Hide file tree

Showing 56 changed files with 8 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ Morphir consists of a few projects based on the features they provide.
 | [Background](./docs/background.md)                                         | [Development Automation (Dev Bots)](./docs/dev_bots.md)                                                    | [Regulatory Technology](./docs/regtech_modeling.md)                                     |
 | [Community](./docs/morphir_community.md)                                   | [Modeling an Application](./docs/application_modeling.md)                                                  |                                                                                         |
 | [What's it all about?](./docs/whats_it_about.md)                           | [Modeling Decision Tables](https://github.com/finos/morphir-examples/tree/master/src/Morphir/Sample/Rules) |                                                                                         |
-| [Why we use Functional Programming?](./docs/why_functional_programming.md) | [Modeling for database developers](./docs/modeling/modeling-for-database-developers.md)                    |
+| [Why we use Functional Programming?](./docs/why_functional_programming.md) | [Modeling for database developers](docs/modeling-for-database-developers.md)                    |
 
 ## Roadmap
 

diff --git a/...a-special-case-of-a-relational-backend.md → ...a-special-case-of-a-relational-backend.md b/...a-special-case-of-a-relational-backend.md → ...a-special-case-of-a-relational-backend.md
diff --git a/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/docs/users-guide/Custom Attributes.md → docs/Custom Attributes.md b/docs/users-guide/Custom Attributes.md → docs/Custom Attributes.md
diff --git a/.../developers-guide/files/Insight-README.md → docs/Insight-README.md b/.../developers-guide/files/Insight-README.md → docs/Insight-README.md
diff --git a/...de/files/springboot/Scala-Json-Backend.md → docs/Scala-Json-Backend.md b/...de/files/springboot/Scala-Json-Backend.md → docs/Scala-Json-Backend.md
diff --git a/...rs-guide/files/TestingFramework-README.md → docs/TestingFramework-README.md b/...rs-guide/files/TestingFramework-README.md → docs/TestingFramework-README.md
diff --git a/...uide/files/Working-With-Results-in-Elm.md → docs/Working-With-Results-in-Elm.md b/...uide/files/Working-With-Results-in-Elm.md → docs/Working-With-Results-in-Elm.md
diff --git a/docs/developers-guide/cadl-docs/README.md → docs/cadl-doc.md b/docs/developers-guide/cadl-docs/README.md → docs/cadl-doc.md
diff --git a/...pers-guide/files/cli-cli2-merging-docs.md → docs/cli-cli2-merging-docs.md b/...pers-guide/files/cli-cli2-merging-docs.md → docs/cli-cli2-merging-docs.md
diff --git a/docs/json-codec-backend/codec-docs.md → docs/codec-docs.md b/docs/json-codec-backend/codec-docs.md → docs/codec-docs.md
diff --git a/docs/users-guide/command_line_tools.md → docs/command_line_tools.md b/docs/users-guide/command_line_tools.md → docs/command_line_tools.md
diff --git a/docs/contributing/index.md → docs/contribution-guide-index.md b/docs/contributing/index.md → docs/contribution-guide-index.md
diff --git a/docs/contribution-guide/README.md → docs/contribution-guide-readme.md b/docs/contribution-guide/README.md → docs/contribution-guide-readme.md
diff --git a/...rs-guide-copied/decorators users guide.md → docs/decorators users guide.md b/...rs-guide-copied/decorators users guide.md → docs/decorators users guide.md
diff --git a/docs/developers-guide/README.md → docs/developer-guide-index.md b/docs/developers-guide/README.md → docs/developer-guide-index.md
@@ -8,7 +8,7 @@ Finally, it provides a step by step walk-throughs on how various Morphir compone
 2. Existing team members intending to improve their abilities on Language Design concepts
 
 ##Content
-1. [Getting Started with Morphir](../README.md) <br>
+1. [Getting Started with Morphir](README.md) <br>
 2. [Overview of Morphir](#)
 3. [The Morphir Architecture](#) <br>
 4. [The Morphir SDK](#) <br>
@@ -19,7 +19,7 @@ Finally, it provides a step by step walk-throughs on how various Morphir compone
     4. [morphir-elm develop](#) <br>
 6. [Interoperability With JavaScript](#) <br>
 7. [Testing Framework](#) <br>
-    1. [CSV testing guide ](files/spark-testing-framework.md)
+    1. [CSV testing guide ](spark-testing-framework.md)
 8. [The Morphir IR](#) <br>
     1. [Overview of the Morphir IR](#) <br>
     2. [Distribution](#) <br>
@@ -32,11 +32,11 @@ Finally, it provides a step by step walk-throughs on how various Morphir compone
     1. [Elm Frontend](#) <br>
     2. [Elm Incremental Frontend](#) <br>
 10. [The Morphir Backends](#) <br>
-    1. [Scala Backend](files/scala-backend.md)
-    2. [Spark Backend](files/spark-backend.md)
-    3. [Relational IR Backends](files/relational-backend.md)
-    4. [Scala Json Codecs Backend](files/scala-backend.md)
-    5. [Json Schema Backend](files/json-schema-mappings.md)
+    1. [Scala Backend](scala-backend.md)
+    2. [Spark Backend](spark-backend.md)
+    3. [Relational IR Backends](relational-backend.md)
+    4. [Scala Json Codecs Backend](scala-backend.md)
+    5. [Json Schema Backend](json-schema-mappings.md)
 11. [Working with CODECS](#) <br>
     1. [Introduction to Encoding/Decoding](#) <br>
     2. [JSON Decoder Building Blocks](#) <br>

diff --git a/docs/developers-guide/files/Json-schema-bakend-config-processing.md b/docs/developers-guide/files/Json-schema-bakend-config-processing.md
diff --git a/docs/developers-guide/files/configuration-management.md b/docs/developers-guide/files/configuration-management.md
diff --git a/docs/users-guide/editor_setup.md → docs/editor_setup.md b/docs/users-guide/editor_setup.md → docs/editor_setup.md
diff --git a/...guide/files/error-append-not-supported.md → docs/error-append-not-supported.md b/...guide/files/error-append-not-supported.md → docs/error-append-not-supported.md
diff --git a/...rs-guide-copied/generating-json-schema.md → docs/generating-json-schema.md b/...rs-guide-copied/generating-json-schema.md → docs/generating-json-schema.md
diff --git a/docs/users-guide/installation.md → docs/installation.md b/docs/users-guide/installation.md → docs/installation.md
diff --git a/docs/using/installation_and_usage.md → docs/installation_and_usage.md b/docs/using/installation_and_usage.md → docs/installation_and_usage.md
diff --git a/...evelopers-guide/json-codec-docs/README.md → docs/json-codecs-doc.md b/...evelopers-guide/json-codec-docs/README.md → docs/json-codecs-doc.md
diff --git a/...s/json-schema-backend-config-test-plan.md → docs/json-schema-backend-config-test-plan.md b/...s/json-schema-backend-config-test-plan.md → docs/json-schema-backend-config-test-plan.md
diff --git a/...ide/files/json-schema-backend-testplan.md → docs/json-schema-backend-testplan.md b/...ide/files/json-schema-backend-testplan.md → docs/json-schema-backend-testplan.md
diff --git a/...elopers-guide/files/json-schema-config.md → docs/json-schema-config.md b/...elopers-guide/files/json-schema-config.md → docs/json-schema-config.md
diff --git a/...s/json-schema-enabled developers guide.md → docs/json-schema-enabled developers guide.md b/...s/json-schema-enabled developers guide.md → docs/json-schema-enabled developers guide.md
diff --git a/...opers-guide/files/json-schema-mappings.md → docs/json-schema-mappings.md b/...opers-guide/files/json-schema-mappings.md → docs/json-schema-mappings.md
diff --git a/...opers-guide/files/json-schema-sample.json → docs/json-schema-sample.json b/...opers-guide/files/json-schema-sample.json → docs/json-schema-sample.json
diff --git a/docs/modeling/modeling-finance.md → docs/modeling-finance.md b/docs/modeling/modeling-finance.md → docs/modeling-finance.md
diff --git a/...eling/modeling-for-database-developers.md → docs/modeling-for-database-developers.md b/...eling/modeling-for-database-developers.md → docs/modeling-for-database-developers.md
diff --git a/docs/modeling/modeling-overview.md → docs/modeling-overview.md b/docs/modeling/modeling-overview.md → docs/modeling-overview.md
diff --git a/docs/modeling/testing.md → docs/modelling-testing.md b/docs/modeling/testing.md → docs/modelling-testing.md
diff --git a/...uide/files/morphir-commands-processing.md → docs/morphir-commands-processing.md b/...uide/files/morphir-commands-processing.md → docs/morphir-commands-processing.md
diff --git a/.../files/morphir-elm-commands-processing.md → docs/morphir-elm-commands-processing.md b/.../files/morphir-elm-commands-processing.md → docs/morphir-elm-commands-processing.md
diff --git a/docs/users-guide/morphir-scala-gen.md → docs/morphir-scala-gen.md b/docs/users-guide/morphir-scala-gen.md → docs/morphir-scala-gen.md
diff --git a/...rs-guide-copied/morphir-typescript-api.md → docs/morphir-typescript-api.md b/...rs-guide-copied/morphir-typescript-api.md → docs/morphir-typescript-api.md
diff --git a/...ers-guide/files/morphirDocumentation.html → docs/morphirDocumentation.html b/...ers-guide/files/morphirDocumentation.html → docs/morphirDocumentation.html
diff --git a/...rs-guide/files/morpir-developers-guide.md → docs/morpir-developers-guide.md b/...rs-guide/files/morpir-developers-guide.md → docs/morpir-developers-guide.md
diff --git a/docs/contribution-guide/publishing.md → docs/publishing.md b/docs/contribution-guide/publishing.md → docs/publishing.md
diff --git a/...elopers-guide/files/relational-backend.md → docs/relational-backend.md b/...elopers-guide/files/relational-backend.md → docs/relational-backend.md
diff --git a/docs/developers-guide/files/scala-backend.md → docs/scala-backend.md b/docs/developers-guide/files/scala-backend.md → docs/scala-backend.md
diff --git a/...-guide/files/scala-json-codecs-backend.md → docs/scala-json-codecs-backend.md b/...-guide/files/scala-json-codecs-backend.md → docs/scala-json-codecs-backend.md
diff --git a/docs/spark-backend/design.md → docs/spark-backend-design.md b/docs/spark-backend/design.md → docs/spark-backend-design.md
diff --git a/...lopers-guide/files/spark-backend-joins.md → docs/spark-backend-joins.md b/...lopers-guide/files/spark-backend-joins.md → docs/spark-backend-joins.md
diff --git a/...de/files/spark-backend-optional-values.md → docs/spark-backend-optional-values.md b/...de/files/spark-backend-optional-values.md → docs/spark-backend-optional-values.md
diff --git a/docs/developers-guide/files/spark-backend.md → docs/spark-backend.md b/docs/developers-guide/files/spark-backend.md → docs/spark-backend.md
diff --git a/...rs-guide/files/spark-testing-framework.md → docs/spark-testing-framework.md b/...rs-guide/files/spark-testing-framework.md → docs/spark-testing-framework.md
diff --git a/...velopers-guide/files/springboot/README.md → docs/spring-boot-readme.md b/...velopers-guide/files/springboot/README.md → docs/spring-boot-readme.md
diff --git a/docs/developers-guide/table-template.md → docs/table-template.md b/docs/developers-guide/table-template.md → docs/table-template.md
diff --git a/docs/tutorials/quick_start.md → docs/tutorials.md b/docs/tutorials/quick_start.md → docs/tutorials.md
diff --git a/docs/developers-guide/files/typescript.md → docs/typescript.md b/docs/developers-guide/files/typescript.md → docs/typescript.md
diff --git a/docs/users-guide-copied/README.md → docs/user-guide-index.md b/docs/users-guide-copied/README.md → docs/user-guide-index.md
diff --git a/docs/users-guide/README.md → docs/user-guide-readme.md b/docs/users-guide/README.md → docs/user-guide-readme.md