Skip to content

Commit 0825f9f

Browse files
committed
Add TOC
1 parent 1840081 commit 0825f9f

File tree

4 files changed

+26
-1
lines changed

4 files changed

+26
-1
lines changed

docs/CUSTOM_CLIENT.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# STAC-Manager 📡 📄 — Custom app
22

3+
- [STAC-Manager 📡 📄 — Custom app](#stac-manager----custom-app)
4+
- [Provider](#provider)
5+
- [Config](#config)
6+
- [From](#from)
7+
38
If you're not using the STAC-Manager client app and want to build your own app using the plugin system, the following guide will help you set up the plugin system in your project.
49

510
## Provider

docs/PLUGINS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# STAC-Manager 📡 📄 — PLUGINS
22

3-
- [STAC-Manager PLUGINS](#stac-manager-plugins)
3+
- [STAC-Manager 📡 📄 — PLUGINS](#stac-manager----plugins)
44
- [Plugin editing schema](#plugin-editing-schema)
55
- [String field](#string-field)
66
- [Number field](#number-field)

docs/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# STAC-Manager 📡 📄 — Technical Documentation
22

3+
- [STAC-Manager 📡 📄 — Technical Documentation](#stac-manager----technical-documentation)
4+
- [Configuration](#configuration)
5+
- [Example config](#example-config)
6+
- [Plugins \& Widgets](#plugins--widgets)
7+
- [Custom Client](#custom-client)
8+
39
STAC-Manager is a react app designed for managing the values of a STAC (SpatioTemporal Asset Catalog) collection and its items.
410
The ecosystem is composed of a web app (the client) and a plugin system that powers it.
511
The different parts of the project are located in the `packages` directory structured as follows:

docs/WIDGETS.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# STAC-Manager 📡 📄 — WIDGETS
22

3+
- [STAC-Manager 📡 📄 — WIDGETS](#stac-manager----widgets)
4+
- [Existent widgets](#existent-widgets)
5+
- [text](#text)
6+
- [number](#number)
7+
- [radio](#radio)
8+
- [checkbox](#checkbox)
9+
- [array](#array)
10+
- [array:string](#arraystring)
11+
- [select](#select)
12+
- [tagger](#tagger)
13+
- [object](#object)
14+
- [json](#json)
15+
- [Creating a new widget](#creating-a-new-widget)
16+
317
The app will render a default widget for each field type, but this can be changed by adding a `ui:widget` property to the field.
418

519
There are different widgets for different field types. The existent widgets can be found in [data-widgets/config](/packages/data-widgets/lib/config/index.ts) and the [WidgetRenderer](/packages/data-core/lib/components/widget-renderer.tsx) is the component responsible for rendering the widgets based on the field type and associated conditions.

0 commit comments

Comments
 (0)