search

ansys / pydpf-core

Data Processing Framework - Python Core
http://dpf.docs.pyansys.com/
MIT License
68 stars 25 forks source link

Improvements to documentation #1711

Open luisaFelixSalles opened 2 months ago

luisaFelixSalles commented 2 months ago

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

  • [ ] General #1762

  • [ ] Getting started

  • [x] User guide

First proposition (#1763 ) After some reviews we got to make some changes :

  • Change the tutorials approach (we were giving api reference we want a step by step guide)
  • Make the solvers types more explicit
  • Make the tutorials titles more "action/feature centered"

Second proposition (#1779 ) After some reviews we got to make some changes :

  • make a simple preview of the tutorials in the user guide page
  • tutorials new layout

Third proposition (#1876 ) After some reviews we got to make some changes :

  • Put tutorials section before the concepts

  • In the basics one -> don't limit DPF to a post processing tool

  • [ ] Examples

  • Add new subsections in the side bar #1752

  • Reorganize where each example is

  • [ ] API Reference

  • Reconfigure the side bar

  • New designs for the cover page of this section #1755

  • [ ] Operators

  • [x] Concepts

  • Merge with the user guide section (#1819 )

  • [ ] Contribute

luisaFelixSalles commented 1 week ago

IDEAS