Skip to content

Conversation

@luisaFelixSalles
Copy link
Contributor

@luisaFelixSalles luisaFelixSalles commented Dec 3, 2024

Change the contributing section:

  • Updates on the main page
  • Add section specific for the documentation
  • Add guidelines to write tutorials

The contributing section is organized as :

.
├── Contributing
│   ├── Documentation
│   │    ├── Tutorials guidelines
│   ├── Develop code

Preview on how it renders

Contributing section main page

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_contributing html (1)

Documentation sub section

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_write_doc_index html (1)

Tutorials guidelines

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_write_doc_guide_lines_tutorials html

Develop code sub section

_D__ANSYSdev_pydpf-core_doc_build_html_getting_started_write_code_index html (1)

@luisaFelixSalles luisaFelixSalles added the tutorials Related to PyDPF-Core tutorials label Dec 3, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Dec 3, 2024
@codecov
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.43%. Comparing base (293a63d) to head (c30027d).
Report is 1 commits behind head on doc/new-tutorials-section.

Additional details and impacted files
@@                      Coverage Diff                      @@
##           doc/new-tutorials-section    #1950      +/-   ##
=============================================================
- Coverage                      88.48%   88.43%   -0.06%     
=============================================================
  Files                             89       89              
  Lines                          10251    10251              
=============================================================
- Hits                            9071     9065       -6     
- Misses                          1180     1186       +6     

@luisaFelixSalles luisaFelixSalles mentioned this pull request Dec 5, 2024
15 tasks
@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16:42
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/guide-lines/firsts-guide-lines branch from b3654d3 to 27c4058 Compare January 3, 2025 14:53
@PProfizi
Copy link
Contributor

PProfizi commented Jan 3, 2025

Remark for later: redirect to the PyAnsys guidelines in the Develop code section.

@PProfizi PProfizi merged commit 0a8fa75 into doc/new-tutorials-section Jan 28, 2025
46 checks passed
@PProfizi PProfizi deleted the tutorials/guide-lines/firsts-guide-lines branch January 28, 2025 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tutorials Related to PyDPF-Core tutorials

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants