diff --git a/README.md b/README.md index 8379bca61c..5887638f58 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ for (const model in models) { - Easily modify how models are constrained into the output + Easily modify how models are constrained into the output diff --git a/docs/README.md b/docs/README.md index 5b194699bd..9364e2fe9e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -48,7 +48,7 @@ Details which different generator options are supported. ### [Presets](./presets.md) Goes more in-depth into how the preset system works, which enables full customization of generators. -### [Interpretation of JSON Schema](./inputs/json_schema.md) +### [Interpretation of JSON Schema](./inputs/JSON_Schema.md) Explains how a JSON Schema is interpreted to a data model. ### [Migration](./migrations/README.md) diff --git a/docs/advanced.md b/docs/advanced.md index c15cf124f8..16ad2a3515 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -23,7 +23,7 @@ This document contains many of the advanced use-cases that you may stumble upon This example shows us how to generate each model in the same file -Check out this [example out for a live demonstration](../examples/generate-all-models-within-same-file). +Check out this [example out for a live demonstration](../examples/generate-all-models-within-the-same-file). ## Generate models to separate files @@ -97,7 +97,7 @@ Check out this [example out for a live demonstration](../examples/change-type-ma ## Changing the constrain rules -When moving from a [MetaModel](./internal-model.md#the-meta-model) to a [ConstrainedMetaModel](./internal-model.md#the-constrained-meta-model) it means we bind the input to a specific output. That output has specific constraints that the input MUST adhere to, [read more about this here](constraints.md). +When moving from a [MetaModel](./internal-model.md#the-meta-model) to a [ConstrainedMetaModel](./internal-model.md#the-constrained-meta-model) it means we bind the input to a specific output. That output has specific constraints that the input MUST adhere to, [read more about this here](constraints/README.md). There can be multiple reasons why you want to change the default constrain rules, and therefore you can form them to your needs. diff --git a/docs/constraints/README.md b/docs/constraints/README.md index 7db869a3b8..2c43f8e175 100644 --- a/docs/constraints/README.md +++ b/docs/constraints/README.md @@ -1,5 +1,5 @@ # Constraints -Because we cannot control what is provided as input, we must constrain the internal model to be valid for the output ([read more about the process here](./internal-model.md)). What is considered valid entirely depends on the output so each have their own set of rules. +Because we cannot control what is provided as input, we must constrain the internal model to be valid for the output ([read more about the process here](../internal-model.md)). What is considered valid entirely depends on the output so each have their own set of rules. As an example lets consider TypeScript as an output. Consider the model name, which are a simple string, but a string which can contain ANY characters and formats. Some of the constraints we have found for the naming of a model are: @@ -16,18 +16,18 @@ class 1name {} There are many rules as such, but to get the full description about the default constraints here: -- [C++](./constraints/Csplusplus.md) -- [C#](./constraints/CSharp.md) -- [Dart](./constraints/Dart.md) -- [Go](./constraints/Go.md) -- [Java](./constraints/Java.md) -- [JavaScript](./constraints/JavaScript.md) -- [Kotlin](./constraints/Kotlin.md) -- [PHP](./constraints/PHP.md) -- [Python](./constraints/Python.md) -- [Rust](./constraints/Rust.md) -- [Scala](./constraints/Scala.md) -- [TypeScript](./constraints/TypeScript.md) +- [C++](./Cplusplus.md) +- [C#](./CSharp.md) +- [Dart](./Dart.md) +- [Go](./Go.md) +- [Java](./Java.md) +- [JavaScript](./JavaScript.md) +- [Kotlin](./Kotlin.md) +- [PHP](./PHP.md) +- [Python](./Python.md) +- [Rust](./Rust.md) +- [Scala](./Scala.md) +- [TypeScript](./TypeScript.md) Even though there are many of these constraints, there might be reasons you want to customize the behavior to make it suit your use-case. Therefore each of the constraint rules can be overwritten completely and allow for you to implement your own behavior. diff --git a/docs/contributing.md b/docs/contributing.md index 5e944abc7c..0613935690 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -118,7 +118,7 @@ To make it easier to contribute a new generator, and to avoid focusing too much 4. Add your [generator to the generator index file](../src/generators/index.ts). Now it's time to adapt the template into what ever it is you are generating: -1. Adapt the [constraint logic](../src/generators/template/constrainer) and the [type constraints](../src/generators/template/TemplateConstrainer.ts) based on what is allowed within your output. Read more about the constraint logic [here](./constraints.md). +1. Adapt the [constraint logic](../src/generators/template/constrainer) and the [type constraints](../src/generators/template/TemplateConstrainer.ts) based on what is allowed within your output. Read more about the constraint logic [here](./constraints/README.md). 2. Add all of the reserved keywords that the models must never generate in the [Constant file](../src/generators/template/Constants.ts). 3. Adapt/create the first renderers. The template by default include two renderers, one for rendering enums and one for classes, but you can create what ever renderers makes sense. For example in Rust it's not called class but struct, so therefore its called a `StructRenderer`. 4. Adapt the file generator and the rendering of the complete models to fit your generator. diff --git a/docs/internal-model.md b/docs/internal-model.md index 4fe749d41a..c29cefb326 100644 --- a/docs/internal-model.md +++ b/docs/internal-model.md @@ -148,7 +148,7 @@ This means that if you accessed `EnumValueModel.key` you would get `something% s How and what are constrained? -The answer to this question is not straightforward, cause each output has unique constraints that the meta models must adhere to. You can read more about [the constraint behavior here](./constraints.md). +The answer to this question is not straightforward, cause each output has unique constraints that the meta models must adhere to. You can read more about [the constraint behavior here](./constraints/README.md). ```mermaid --- diff --git a/docs/other-tools.md b/docs/other-tools.md index de7a41bd03..3046387bec 100644 --- a/docs/other-tools.md +++ b/docs/other-tools.md @@ -23,7 +23,7 @@ Here is some of the noticeable differences with Modelina that is nice to know be 1. Modelina does not care much about the input, and support a range of them with no real limitation. I.e. supporting AsyncAPI, OpenAPI, ..., etc, see [supported inputs for more information](../README.md#features). 2. Modelina does not care about output language, i.e. it's not only Java that is supported, see the full list of [supported outputs here](../README.md#features). 3. Modelina does not hardcode specific features such as serialization libraries i.e. Jackson, Gson, ..., or validation annotations. Instead we use [presets](./presets.md) to control what is being generated to never be limited by hardcoding. Read more about which [serialization libraries we support for Java here](./languages/Java.md#generate-serializer-and-deserializer-functionality). -4. Modelina does not care which types you want generated (primitive types, long integers, etc), this can be [controlled by the constrainer](./constraints.md). Read more about how to [change the type mapping](./constraints.md#type-mapping). +4. Modelina does not care which types you want generated (primitive types, long integers, etc), this can be [controlled by the constrainer](./constraints/README.md). Read more about how to [change the type mapping](./constraints/README.md#type-mapping). 5. Modelina is part of Linux Foundation and is therefore a neutral ground for collaboration. diff --git a/modelina-website/src/pages/index.tsx b/modelina-website/src/pages/index.tsx index da93efd5a2..db2c62d9a8 100644 --- a/modelina-website/src/pages/index.tsx +++ b/modelina-website/src/pages/index.tsx @@ -171,7 +171,7 @@ for (const model in models) { Easily modify how models are{' '} - + constrained {' '} into the into the output