Avaiga / taipy-doc

Holds the documentation set for Taipy, not including the code documentation obviously.
https://docs.taipy.io/
Apache License 2.0
12 stars 14 forks source link

Some tutorials should be combined with manual pages and deleted #1069

Open FlorianJacta opened 1 month ago

FlorianJacta commented 1 month ago

Description

Some tutorials were initially created to address gaps in the manual documentation. Now that the manuals are more comprehensive, certain tutorials should be deleted and their content integrated into the Manuals.

The Manuals should also adopt a more tutorial-like approach, incorporating more examples.

Below is a list of tutorials that can be merged into the Manuals:

These tutorials are not really tutorials, tips, or articles but were created as part of another set of documentation.

The tutorial section should be about creating an application or using Taipy to do x and y. Not to explain Taipy features like multi-page, how to use tables, how to use callbacks...

Expected Change

A description of the desired outcome:

FlorianJacta commented 1 month ago

Here is my proposition. What I would like to deeply change are these three pages from the Manuals:

Pages should be a folder where you can learn about dialogs, panes, and partials, how to create a Multi-Page app, and how to navigate between different pages.

You could learn what it is, how to use user-defined and global callbacks, their differences, and how to use asynchronous callbacks.

Binding variables should define what binding variables are, how to create other properties, and how to use Python expressions and lambdas.

FlorianJacta commented 1 month ago

Pages

image

The length of the index page is reduced to show what a user needs to create, build, and define a page/pages only.

Navigate between pages

image

How to navigate between pages: 4 ways to do so and each one with code examples.

Partials

image

Tutorial on partials to explain what a partial is and how to use it.

Dialog

image

I should provide code examples that work almost directly.

Advanced

image

Non primary information on pages

FabienLelaquais commented 1 month ago

I love it!

github-actions[bot] commented 1 week ago

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.