Skip to content

Conversation

@luisaFelixSalles
Copy link
Contributor

@luisaFelixSalles luisaFelixSalles commented Sep 19, 2024

This PR changes the user guide section

  • Add the tutorials subsection
  • Adapt the index page of the main page and of the subsections (all the cards design)
  • Change the sidebar: add captions for each subsection

image
image
image
image

@luisaFelixSalles luisaFelixSalles added the documentation Improvements or additions to documentation label Sep 19, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Sep 19, 2024
@codecov
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (doc/general-layout@0a6f461). Learn more about missing BASE report.

Additional details and impacted files
@@                  Coverage Diff                  @@
##             doc/general-layout    #1763   +/-   ##
=====================================================
  Coverage                      ?   87.10%           
=====================================================
  Files                         ?       83           
  Lines                         ?     9948           
  Branches                      ?        0           
=====================================================
  Hits                          ?     8665           
  Misses                        ?     1283           
  Partials                      ?        0           

@luisaFelixSalles luisaFelixSalles marked this pull request as ready for review September 20, 2024 09:04
The goals of this section are to:

- Describe the most-used DPF entities and how they can help you to access and modify solver data.
- Provide simple how-tos for tackling the most common use cases.
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention the tutorials?



.. card:: Use DPF Server package
.. grid-item-card:: Use DPF Server package
Copy link
Contributor

Choose a reason for hiding this comment

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

It redirects to the Getting Started page for DPF Server, so remove it from here

@PProfizi
Copy link
Contributor

@luisaFelixSalles the doc step is failing because the create_sites_for_python_operators.* scripts should not be moved.

@luisaFelixSalles
Copy link
Contributor Author

luisaFelixSalles commented Sep 23, 2024

@luisaFelixSalles the doc step is failing because the create_sites_for_python_operators.* scripts should not be moved.

You prefer if I change the reference in the other file or if I replace it ? @PProfizi

@luisaFelixSalles luisaFelixSalles merged commit 2d4f565 into doc/general-layout Sep 24, 2024
42 checks passed
@luisaFelixSalles luisaFelixSalles deleted the doc/user-guide-layout branch September 24, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants