-
Notifications
You must be signed in to change notification settings - Fork 26
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
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this 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?
Co-authored-by: Jean-Robin <[email protected]>
There was a problem hiding this 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.
Co-authored-by: Jean-Robin <[email protected]>
…n description and customize the application sections
There was a problem hiding this 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.
There was a problem hiding this 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
Co-authored-by: Jean-Robin <[email protected]>
There was a problem hiding this 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.
…eginning of the doc page
I am getting 404 answers on the new |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this 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]>
Resolves #1209
See temporary results on ReadTheDocs/doc-1209-application-templates.
TODO: