Skip to content

Commit 5cbe864

Browse files
AnnMarieWAnnMarieW
committed
docs edits
1 parent cd6c417 commit 5cbe864

8 files changed

+40
-36
lines changed

‎README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@ This repository contains a work-in-progress technical preview of potential futur
33

44
## Documentation
55
The documentation for Dash Labs can be found in the [docs/](./docs/) directory.
6-
- [01-Overview.md](https://github.com/plotly/dash-labs/blob/main/docs/01-Overview.md)
6+
- [01-Overview.md](https://github.com/plotly/dash-labs/blob/main/docs/01-Overview.md)
7+
8+
_Archived in dash-labs v0.4.0:_
79
- [02-CallbackEnhancements.md](https://github.com/plotly/dash-labs/blob/main/docs/02-CallbackEnhancements.md)
810
- [03-TemplateLayoutSystem.md](https://github.com/plotly/dash-labs/blob/main/docs/03-TemplateLayoutSystem.md)
911
- [04-PredefinedTemplates.md](https://github.com/plotly/dash-labs/blob/main/docs/04-PredefinedTemplates.md)
1012
- [05-ComponentPlugingPattern.md](https://github.com/plotly/dash-labs/blob/main/docs/05-ComponentPlugingPattern.md)
1113
- [06-TemplateIntegrationAndMigration.md](https://github.com/plotly/dash-labs/blob/main/docs/06-TemplateIntegrationAndMigration.md)
1214
- [07-LongCallback.md](https://github.com/plotly/dash-labs/blob/main/docs/07-LongCallback.md)
13-
- [08-MultiPageDashApp.md](https://github.com/plotly/dash-labs/blob/main/docs/08-MultiPageDashApp.md)
1415

15-
Various demos are located in the [docs/demos](./docs/demos) directory.
16+
_New in dash-labs v1.0.0:_
17+
- [08-MultiPageDashApp.md](https://github.com/plotly/dash-labs/blob/main/docs/08-MultiPageDashApp.md)
18+
19+
Examples and demos are located in the [docs/demos](./docs/demos) directory.
1620

1721
## Installation
1822
To install the tech preview:

‎docs/02-CallbackEnhancements.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

2-
> # Status: Callback Enhancements
3-
> ### These callback enhancements were added to Dash 2.0 🎉
4-
> ### See the [Flexible Callback Signature section](https://dash.plotly.com/flexible-callback-signatures) in the Dash documentation.
2+
> ## Status: Callback Enhancements
3+
> #### These callback enhancements were added to Dash 2.0 🎉
4+
> #### See the [Flexible Callback Signature section](https://dash.plotly.com/flexible-callback-signatures) in the Dash documentation.
55
66

77
```diff
88
- ----------------------------------------------------------------------------------
99
- This documentation describes code in a previous version of dash-labs (v0.4.0)
10-
- and is inclded here for legacy purposes only.
10+
- and is included here for legacy purposes only.
1111
- ----------------------------------------------------------------------------------
1212
```
1313

‎docs/03-TemplateLayoutSystem.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
> # Status: Template Layout System
3-
> ### Based on community feedback, this version of the template layout system will not be added to a future version of Dash. However, the work done here inspired many new features, such as:
4-
> ### - New in Dash 2.1: The [low-code shorthands](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-core-components) for Dash Core Components and the dash DataTable.
5-
> ### - New in Dash 2.1, The Input, State, and Output [accepts components instead of ID strings](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-and-dash-renderer). Dash callback will auto-generate the component's ID under-the-hood if not supplied.
6-
> ### - Available in the [dash-bootstrap-templates](https://pypi.org/project/dash-bootstrap-templates/) library: Bootstrap themed figures.
2+
> ## Status: Template Layout System
3+
> #### Based on community feedback, this version of the template layout system will not be added to a future version of Dash. However, the work done here inspired many new features, such as:
4+
> #### - New in Dash 2.1: The [low-code shorthands](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-core-components) for Dash Core Components and the dash DataTable.
5+
> #### - New in Dash 2.1, The Input, State, and Output [accepts components instead of ID strings](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-and-dash-renderer). Dash callback will auto-generate the component's ID under-the-hood if not supplied.
6+
> #### - Available in the [dash-bootstrap-templates](https://pypi.org/project/dash-bootstrap-templates/) library: Bootstrap themed figures.
77
88

99
> We appreciate everyone's input on the template system. Templates are still in the dash-labs project plan, so stay tuned for a new version!
@@ -12,7 +12,7 @@
1212
```diff
1313
- ----------------------------------------------------------------------------------
1414
- This documentation describes code in a previous version of dash-labs (v0.4.0)
15-
- and is inclded here for legacy purposes only.
15+
- and is included here for legacy purposes only.
1616
- ----------------------------------------------------------------------------------
1717
```
1818

‎docs/04-PredefinedTemplates.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
> # Status: Template Layout System
3-
> ### Based on community feedback, this version of the template layout system will not be added to a future version of Dash. However, the work done here inspired many new features, such as:
4-
> ### - New in Dash 2.1: The [low-code shorthands](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-core-components) for Dash Core Components and the dash DataTable.
5-
> ### - New in Dash 2.1, The Input, State, and Output [accepts components instead of ID strings](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-and-dash-renderer). Dash callback will auto-generate the component's ID under-the-hood if not supplied.
6-
> ### - Available in the [dash-bootstrap-templates](https://pypi.org/project/dash-bootstrap-templates/) library: Bootstrap themed figures.
2+
> ## Status: Template Layout System
3+
> #### Based on community feedback, this version of the template layout system will not be added to a future version of Dash. However, the work done here inspired many new features, such as:
4+
> #### - New in Dash 2.1: The [low-code shorthands](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-core-components) for Dash Core Components and the dash DataTable.
5+
> #### - New in Dash 2.1, The Input, State, and Output [accepts components instead of ID strings](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-and-dash-renderer). Dash callback will auto-generate the component's ID under-the-hood if not supplied.
6+
> #### - Available in the [dash-bootstrap-templates](https://pypi.org/project/dash-bootstrap-templates/) library: Bootstrap themed figures.
77
88

99
> We appreciate everyone's input on the template system. Templates are still in the dash-labs project plan, so stay tuned for a new version!
@@ -12,7 +12,7 @@
1212
```diff
1313
- ----------------------------------------------------------------------------------
1414
- This documentation describes code in a previous version of dash-labs (v0.4.0)
15-
- and is inclded here for legacy purposes only.
15+
- and is included here for legacy purposes only.
1616
- ----------------------------------------------------------------------------------
1717
```
1818

‎docs/05-ComponentPlugingPattern.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

2-
> # Status: Component Plugin design pattern
3-
> ### This version of the component plug-in design pattern will not be added to a future version of Dash. However, this was the precursor for the All-in-One Components that were added to Dash 2.0 🎉
4-
> ### See the [All-in-One Components section](https://dash.plotly.com/all-in-one-components) in the Dash documentation
2+
> ## Status: Component Plugin design pattern
3+
> #### This version of the component plug-in design pattern will not be added to a future version of Dash. However, this was the precursor for the All-in-One Components that were added to Dash 2.0 🎉
4+
> #### See the [All-in-One Components section](https://dash.plotly.com/all-in-one-components) in the Dash documentation
55
66

77
```diff
88
- ----------------------------------------------------------------------------------
99
- This documentation describes code in a previous version of dash-labs (v0.4.0)
10-
- and is inclded here for legacy purposes only.
10+
- and is included here for legacy purposes only.
1111
- ----------------------------------------------------------------------------------
1212
```
1313

‎docs/06-TemplateIntegrationAndMigration.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

2-
> # Status: Template Layout System
3-
> ### Based on community feedback, this version of the template layout system will not be added to a future version of Dash. However, the work done here inspired many new features, such as:
4-
> ### - New in Dash 2.1: The [low-code shorthands](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-core-components) for Dash Core Components and the dash DataTable.
5-
> ### - New in Dash 2.1, The Input, State, and Output [accepts components instead of ID strings](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-and-dash-renderer). Dash callback will auto-generate the component's ID under-the-hood if not supplied.
6-
> ### - Available in the [dash-bootstrap-templates](https://pypi.org/project/dash-bootstrap-templates/) library: Bootstrap themed figures.
2+
> ## Status: Template Layout System
3+
> #### Based on community feedback, this version of the template layout system will not be added to a future version of Dash. However, the work done here inspired many new features, such as:
4+
> #### - New in Dash 2.1: The [low-code shorthands](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-core-components) for Dash Core Components and the dash DataTable.
5+
> #### - New in Dash 2.1, The Input, State, and Output [accepts components instead of ID strings](https://github.com/plotly/dash/blob/dev/CHANGELOG.md#dash-and-dash-renderer). Dash callback will auto-generate the component's ID under-the-hood if not supplied.
6+
> #### - Available in the [dash-bootstrap-templates](https://pypi.org/project/dash-bootstrap-templates/) library: Bootstrap themed figures.
77
88

99
> We appreciate everyone's input on the template system. Templates are still in the dash-labs project plan, so stay tuned for a new version!
@@ -12,7 +12,7 @@
1212
```diff
1313
- ----------------------------------------------------------------------------------
1414
- This documentation describes code in a previous version of dash-labs (v0.4.0)
15-
- and is inclded here for legacy purposes only.
15+
- and is included here for legacy purposes only.
1616
- ----------------------------------------------------------------------------------
1717
```
1818

‎docs/07-LongCallback.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

2-
> # Status: Long Callbacks
3-
> ### The long callback handling was added to Dash 2.0 🎉
4-
> ### See the [Long Callback section](https://dash.plotly.com/long-callbacks) in the Dash documentation
2+
> ## Status: Long Callbacks
3+
> #### The long callback handling was added to Dash 2.0 🎉
4+
> #### See the [Long Callback section](https://dash.plotly.com/long-callbacks) in the Dash documentation
55
66

77
```diff
88
- ----------------------------------------------------------------------------------
99
- This documentation describes code in a previous version of dash-labs (v0.4.0)
10-
- and is inclded here for legacy purposes only.
10+
- and is included here for legacy purposes only.
1111
- ----------------------------------------------------------------------------------
1212
```
1313

‎docs/08-MultPageDashApp.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
> # Status: Multi-Page Dash App Plugin
3-
> ### Under active development: A plugin to simplify creating multi-page Dash apps. This is a preview of functionality that will be added to Dash 2.1.
2+
> ## Status: Multi-Page Dash App Plugin
3+
> #### Under active development: A plugin to simplify creating multi-page Dash apps. This is a preview of functionality that will be added to Dash 2.1.
44
> **[See the community announcement for details and discussion](https://community.plotly.com/t/introducing-dash-pages-dash-2-1-feature-preview/57775/2)**
55
66

@@ -251,7 +251,7 @@ However, we recommend splitting out the page layouts into their own files in `pa
251251

252252

253253

254-
## Refrence
254+
## Reference
255255

256256
**`dash.register_page`**
257257

0 commit comments

Comments
 (0)