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

Improvements to documentation #1711

Open
luisaFelixSalles opened this issue Aug 23, 2024 · 1 comment
Open

Improvements to documentation #1711

luisaFelixSalles opened this issue Aug 23, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@luisaFelixSalles
Copy link
Collaborator

luisaFelixSalles commented Aug 23, 2024

This issue tracks PyDPF-Core issues related to improvements made to the PyDPF-Core documentation

Documentation system

How should we organize the documentation website?

Sections

  • Getting started
  • API Reference
  • Reconfigure the side bar
  • New designs for the cover page of this section
  • Operators
  • Concepts
  • Erase and merge with the user guide section
  • Contribute
@luisaFelixSalles luisaFelixSalles self-assigned this Aug 23, 2024
@luisaFelixSalles luisaFelixSalles added the documentation Improvements or additions to documentation label Aug 23, 2024
@luisaFelixSalles
Copy link
Collaborator Author

Layout changes

  • Add caption in the toctree for better sidebar design

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

No branches or pull requests

1 participant