Skip to content

Commit 131a0d8

Browse files
authored
Refine configuration docs
1 parent 9305664 commit 131a0d8

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ STAC-Manager is a react app designed for managing the values of a STAC (SpatioTe
1010
The ecosystem is composed of a web app (the client) and a plugin system that powers it.
1111
The different parts of the project are located in the `packages` directory structured as follows:
1212

13-
- [`@stac-manager/client`](./packages/client) - STAC-Manager web app.
14-
- [`@stac-manager/data-core`](./packages/data-core) - Core functionality of the form builder plugin system.
15-
- [`@stac-manager/data-widgets`](./packages/data-widgets) - Form components to be used by the form builder plugin system, when custom ones are not provided.
16-
- [`@stac-manager/data-plugins`](./packages/data-plugins) - Data plugins for the forms. Each plugin defines how a section of the data structure is displayed and edited.
13+
- [`@stac-manager/client`](../packages/client) - STAC-Manager web app.
14+
- [`@stac-manager/data-core`](../packages/data-core) - Core functionality of the form builder plugin system.
15+
- [`@stac-manager/data-widgets`](../packages/data-widgets) - Form components to be used by the form builder plugin system, when custom ones are not provided.
16+
- [`@stac-manager/data-plugins`](../packages/data-plugins) - Data plugins for the forms. Each plugin defines how a section of the data structure is displayed and edited.
1717

1818
The `@stac-manager/data-*` packages contain the default implementation of the plugin system, the widgets used to render the forms and some core functions to allow the system to be extended.
1919

@@ -22,12 +22,18 @@ Each plugin handles a specific part of the data and is responsible for defining
2222

2323
## Configuration
2424

25+
### Client
26+
27+
See the client-specific instructions, such as configuring the server's STAC API, in the [README of the client package](../packages/client#client-specific-instructions).
28+
29+
### Plugins
30+
2531
STAC-Manager's [config file](/packages/client/src/plugin-system/config.ts) specifies the plugins that the app uses for Collections and Items while extending the `Default Plugin Widget Configuration` which defines the widgets for the basic field types.
2632
_See the [data-widgets/config](/packages/data-widgets/lib/config/index.ts) for a list of existent widgets._
2733

2834
When creating a new plugin or a new widget, the configuration should be updated with the new plugin/widget.
2935

30-
### Example config
36+
#### Example config
3137

3238
The config object should contain a list of plugins to use for the collections and items, as well as the widget configuration (which widgets to use for which field types).
3339

0 commit comments

Comments
 (0)