Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
FlorianJacta opened this issue Aug 1, 2024 · 5 comments
Open
Labels
📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be fixed soon 🔒 Staff only Restricted to CC staff members

Comments

@FlorianJacta
Copy link
Member

FlorianJacta commented Aug 1, 2024

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:

  • Delete the specified tutorials.
  • Integrate their content into the relevant sections of the Manuals.
  • Enhance the Manuals with more examples to make them more example-driven.
@FlorianJacta FlorianJacta added 📈 Improvement Improvement of a feature. 📄 Documentation Internal or public documentation 🟨 Priority: Medium Not blocking but should be fixed soon labels Aug 1, 2024
@FlorianJacta
Copy link
Member Author

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
Copy link
Member Author

FlorianJacta commented Aug 5, 2024

Pages

image

  • How to create and define a page for a single-page application.
  • And how to create a multi-page application

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
Copy link
Member

I love it!

FlorianJacta added a commit that referenced this issue Aug 6, 2024
FlorianJacta added a commit that referenced this issue Aug 6, 2024
@jrobinAV jrobinAV added the 🔒 Staff only Restricted to CC staff members label Aug 19, 2024
Copy link

github-actions bot commented Sep 6, 2024

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.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Sep 6, 2024
@github-actions github-actions bot removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label Sep 20, 2024
Copy link

This issue has been unassigned automatically because it has been marked as "🥶Waiting for contributor" for more than 14 days with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be fixed soon 🔒 Staff only Restricted to CC staff members
Projects
None yet
Development

No branches or pull requests

3 participants