Skip to content

Commit 4ac41f9

Browse files
committed
improved docs
1 parent b30a3e7 commit 4ac41f9

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/guide/contributors.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
As an application contributor you enhance an existing web application
44
by UI contributions developed in Python. You implement a Python module
55
that is consumed by (one of) the application's backend servers that
6-
implements expected Chartlets REST API as outlined above.
6+
implement the Chartlets REST API as described in the
7+
[Contributors Guide](./contributors.md).
78

89
Your module is supposed to export one or more instances of the
910
`chartlets.Extension` class. An extension object is a container for your

docs/guide/providers.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ server-side UI-contributions provided by an application contributor.
55

66
## How Chartlets works
77

8-
Users write the widgets in, e.g. Python, and a REST server implements three
9-
endpoints to publish the widgets:
8+
The basic idea is that application contributors develop the
9+
UI-contributions in Python and a REST server developed by you, the
10+
application provider, implements three endpoints to publish the
11+
UI-contributions to a frontend application:
1012

1113
- `GET /contributions`: Called once after application UI starts up.
1214
Returns an object whose keys are contribution points (e.g., "panels")
@@ -15,18 +17,19 @@ endpoints to publish the widgets:
1517
Called once for every contribution when it becomes visible in the UI.
1618
Returns the contribution's initial component tree.
1719
- `POST /callback`:
18-
Called when users interact with the component tree or on application
19-
state changes. Returns an array of contribution changes where each
20-
contribution change contains an array of actions to be applied to the
20+
Called when application users interact with the component tree or on
21+
application state changes. Returns an array of contribution changes where
22+
each contribution change contains an array of actions to be applied to the
2123
component tree.
2224

23-
The following sequence diagram depicts how the library is supposed to
24-
work. The top shows the JavaScript frontend that uses this library.
25-
The bottom shows the lifeline of the backend REST server.
25+
The following sequence diagram depicts the framework in action.
26+
The top shows the frontend application that uses the Chartlets JavaScript
27+
library. The bottom shows the lifeline of the backend REST server that uses
28+
the Chartlets Python library.
2629

2730
![sequence.png](../images/sequence.png)
2831

29-
## Backend integration
32+
## REST server integration
3033

3134
The Chartlets backend implementation is provided by the module
3235
`chartlets.controllers` of the Python package `chartlets`.
@@ -99,7 +102,7 @@ the controller implementations in `chartlets.controllers`.
99102

100103
As an example, see [`app.py` of the demo server](https://github.com/bcdev/chartlets/tree/main/chartlets.py/demo/server/app.py).
101104

102-
## Frontend integration
105+
## Application UI integration
103106

104107
The JavaScript package `chartlets` provides the types, actions, and hooks
105108
to allow for supporting server-side UI contributions in your React
@@ -150,6 +153,6 @@ _Coming soon._
150153

151154
_Coming soon._
152155

153-
## Extend the framework
156+
## Extending the framework
154157

155158
_Coming soon._

0 commit comments

Comments
 (0)