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

Doc/#1209 - #1250 - Add documentation page for each application and page template #1263

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

trgiangdo
Copy link
Member

@trgiangdo trgiangdo commented Jan 22, 2025

Resolves #1209

See temporary results on ReadTheDocs/doc-1209-application-templates.

TODO:

  • Add sections for page templates when ready

@trgiangdo trgiangdo added 📈 Improvement Improvement of a feature. 📄 Documentation Internal or public documentation labels Jan 22, 2025
@trgiangdo trgiangdo self-assigned this Jan 22, 2025
Copy link
Member

@FlorianJacta FlorianJacta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would move the templates/ folder from docs/userman/ecosystem/ to docs/. I propose to expose the templates at the top level next to the tutorials. On the contrary, the cli/ folder remains unchanged, under docs/userman/ecosystem/ folder. Does it make sense?

I would also like to have a templates/index.md page that list all templates (for application and page).

What do you think?

@trgiangdo trgiangdo requested a review from jrobinAV February 5, 2025 09:23
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions are not real suggestions but just a proposal for some new sections and new titles.

trgiangdo and others added 2 commits February 7, 2025 22:07
…n description and customize the application sections
Copy link
Member Author

@trgiangdo trgiangdo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the sdm.md file with the new structure.

@jrobinAV Please review this page.

When it's ok, I will restructure the default.md with similar structure.

@trgiangdo trgiangdo requested a review from jrobinAV February 8, 2025 10:38
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly max line length

Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also add UI screenshots to make the doc appealing and to quickly explain the features available for an end-user.

@trgiangdo trgiangdo changed the title Doc/#1209 - Add documentation page for each application template Doc/#1209 - #1250 - Add documentation page for each application and page template Feb 17, 2025
@jrobinAV
Copy link
Member

I am getting 404 answers on the new templates chapter. I believe the folder name templates is not allowed by mkdocs. When I tried with tmplates, it worked like a charm.

Comment on lines 1 to 12
Building a Taipy application with multiple complex scenarios usually requires a
significant amount of time and effort, in particular at the beginning of a project
when the user interface requirements are not completely stable. This can delay the
time-to-market and increase development costs.

To reduce the development time, Taipy provides a scenario management application template,
which leverages Taipy visual elements to speed up bootstrapping a standard application.

Out-of-the-box, the scenario management application is a multi-page Taipy application
that allows the user to visualize and manage scenarios and data nodes. The user can select a
scenario, view its directed acyclic graph (DAG), manage its data nodes, upload data files,
and submit the scenario for execution.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Building a Taipy application with multiple complex scenarios usually requires a
significant amount of time and effort, in particular at the beginning of a project
when the user interface requirements are not completely stable. This can delay the
time-to-market and increase development costs.
To reduce the development time, Taipy provides a scenario management application template,
which leverages Taipy visual elements to speed up bootstrapping a standard application.
Out-of-the-box, the scenario management application is a multi-page Taipy application
that allows the user to visualize and manage scenarios and data nodes. The user can select a
scenario, view its directed acyclic graph (DAG), manage its data nodes, upload data files,
and submit the scenario for execution.
The scenario management template provides a foundational structure for applications
requiring scenario-based analysis and data management. It's designed to help users create,
manage, and compare different scenarios to facilitate decision-making and what-if
analyses. It is ideal for applications in forecasting, simulation, and optimization, where
multiple scenarios need to be evaluated and compared.
Out of the box, the template provides a multi-page application structure with two pages predefined:
- A scenario page to select, visualize, submit, analyze, and manage scenarios and data nodes.
- A job page to monitor and manage submissions and jobs.

Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure that " binding variable" does not appear.
It is confusing.

Co-authored-by: Jean-Robin <[email protected]>
Co-authored-by: Fabien Lelaquais <[email protected]>
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add user manual documentation on templates
4 participants