Added index pages, giving the option to add documentation on root paths, like in the administration section
This commit is contained in:
parent
0a93300624
commit
dc0b8ff85c
|
|
@ -6,7 +6,7 @@ In this page, there is a listing where you can view details about all the availa
|
|||
|
||||
:::info
|
||||
|
||||
**Plan Blueprints** describe how a [Plan](/docs/category/plans) is structured. All the sections and fields a Plan is consisting of, are referenced here. More details will follow in the next sections.
|
||||
**Plan Blueprints** describe how a [Plan](/docs/documentation/application/plans) is structured. All the sections and fields a Plan is consisting of, are referenced here. More details will follow in the next sections.
|
||||
|
||||
:::
|
||||
|
||||
|
|
@ -96,12 +96,12 @@ Every section must have a `System` field of the following types: `Title`, `Descr
|
|||
|
||||
### Description Templates form
|
||||
|
||||
Each section can have one or more **description templates** attached to it. When you 'attach' a [description template](/docs/documentation/administration/templates/) to a blueprint, every [plan](/docs/category/plans) that inherits from that blueprint must have a [description](/docs/category/descriptions) that inherits from that template. More details will follow. You can add a description template by clicking on the `Add Description Template` button. For every template you add, a new form part appears where you can specify everything about the template attachment. You can also delete one template clicking on the `delete` icon on the right end of its form.
|
||||
Each section can have one or more **description templates** attached to it. When you 'attach' a [description template](/docs/documentation/administration/templates/) to a blueprint, every [plan](/docs/documentation/application/plans) that inherits from that blueprint must have a [description](/docs/documentation/application/descriptions) that inherits from that template. More details will follow. You can add a description template by clicking on the `Add Description Template` button. For every template you add, a new form part appears where you can specify everything about the template attachment. You can also delete one template clicking on the `delete` icon on the right end of its form.
|
||||
|
||||
- **Description Template**: The [template](/docs/documentation/administration/templates/) you want to add.
|
||||
- **Label**: A label for the template.
|
||||
- **Min Multiplicity**: The minimum amount of [descriptions](/docs/category/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/category/plans) based on this blueprint has to have.
|
||||
- **Max Multiplicity**: The maximum amount of [descriptions](/docs/category/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/category/plans) based on this blueprint has to have.
|
||||
- **Min Multiplicity**: The minimum amount of [descriptions](/docs/documentation/application/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/documentation/application/plans) based on this blueprint has to have.
|
||||
- **Max Multiplicity**: The maximum amount of [descriptions](/docs/documentation/application/descriptions) with this [description template](/docs/documentation/administration/templates/) that a [plan](/docs/documentation/application/plans) based on this blueprint has to have.
|
||||
|
||||
:::tip
|
||||
|
||||
|
|
@ -116,7 +116,7 @@ Let's clarify a little bit more about our description multiplicity options. Ther
|
|||
|
||||
### Prefilling Sources form
|
||||
|
||||
Here, we specify which of the available prefilling sources will be available for the user to select, when he creates a [plan](/docs/category/plans) using this blueprint. We will explore how these are configured in detail in the [Prefilling Configurations](/docs/documentation/administration/blueprints/prefilling-configurations) section.
|
||||
Here, we specify which of the available prefilling sources will be available for the user to select, when he creates a [plan](/docs/documentation/application/plans) using this blueprint. We will explore how these are configured in detail in the [Prefilling Configurations](/docs/documentation/administration/blueprints/prefilling-configurations) section.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ description: View details about the prefilling sources
|
|||
|
||||
# Prefilling Configurations
|
||||
|
||||
In this page, there is a listing where you can view details about all the configured prefilling sources. These are data sources coming outside of the platform, in order to help the user with filling out a [plan](/docs/category/plans) form with some basic information.
|
||||
In this page, there is a listing where you can view details about all the configured prefilling sources. These are data sources coming outside of the platform, in order to help the user with filling out a [plan](/docs/documentation/application/plans) form with some basic information.
|
||||
|
||||
The information displayed by default is: the `label` of the source, the `status` and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,5 +12,5 @@ There are a lot of views in the application available only for users that are gi
|
|||
- **Notification Templates**: Being able to modify the structure of notifications sent to users based on different events.
|
||||
- **Languages**: Being able to add support for more languages or modify existing ones.
|
||||
- **Reference Types**: Being able to configure static or external data sources that are made available as autocomplete fields on the forms of the platform.
|
||||
- **Plan Blueprints**: Being able to control the blueprints available for [plans](/docs/category/plans).
|
||||
- **Description Templates**: Being able to control the templates available for [descriptions](/docs/category/descriptions)
|
||||
- **Plan Blueprints**: Being able to control the blueprints available for [plans](/docs/documentation/application/plans).
|
||||
- **Description Templates**: Being able to control the templates available for [descriptions](/docs/documentation/application/descriptions)
|
||||
|
|
@ -9,7 +9,7 @@ In this page, there is a listing where you can view details about all the availa
|
|||
|
||||
:::info
|
||||
|
||||
A **reference type** is any type of information that is made available to the users when they fill [plan](/docs/category/plans) forms. This information is either static, or coming from an outside source (*an external API*). These sources are extremely configurable as we will see in this section.
|
||||
A **reference type** is any type of information that is made available to the users when they fill [plan](/docs/documentation/application/plans) forms. This information is either static, or coming from an outside source (*an external API*). These sources are extremely configurable as we will see in this section.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ In this page, there is a listing where you can view details about all the availa
|
|||
|
||||
:::info
|
||||
|
||||
**Description Templates** describe how a [Description](/docs/category/descriptions) is structured. All the chapters and fields a Description is consisting of, are referenced here. More details will follow in the next sections.
|
||||
**Description Templates** describe how a [Description](/docs/documentation/application/descriptions) is structured. All the chapters and fields a Description is consisting of, are referenced here. More details will follow in the next sections.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Application",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Descriptions",
|
||||
"position": 6,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Descriptions
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Application
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Plans",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Plans
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "For Developers",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "APIs",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# APIs
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Authentication",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Authentication
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# For Developers
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Getting Started",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
# Getting Started
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Supplementary Services",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Supplementary Services
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"label": "Notifications",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
"type": "doc",
|
||||
"id": "index"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# Notifications
|
||||
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
<DocCardList />
|
||||
|
|
@ -91,15 +91,15 @@ const config: Config = {
|
|||
items: [
|
||||
{
|
||||
label: 'Getting Started',
|
||||
to: '/docs/category/getting-started',
|
||||
to: '/docs/documentation/getting-started',
|
||||
},
|
||||
{
|
||||
label: 'Application',
|
||||
to: '/docs/category/application',
|
||||
to: '/docs/documentation/application',
|
||||
},
|
||||
{
|
||||
label: 'Supplementary Services',
|
||||
to: '/docs/category/supplementary-services',
|
||||
to: '/docs/documentation/supplementary-services',
|
||||
},
|
||||
{
|
||||
label: 'Administration',
|
||||
|
|
@ -107,7 +107,7 @@ const config: Config = {
|
|||
},
|
||||
{
|
||||
label: 'For Developers',
|
||||
to: '/docs/category/for-developers',
|
||||
to: '/docs/documentation/for-devs',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
|
|
|||
Loading…
Reference in New Issue