ansys / ansys/pyfluent

[DOC]: Improve examples section

Open Beginner friendly
#5,327 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
497
Forks
77
Avg merge
22h 37m
Merged PRs (30d)
45

Description

### 🔗 Affected page or URL

https://fluent.docs.pyansys.com/version/dev/examples/index.html

### ⚠️ What is wrong or missing?

The entire examples section is rendering a bit patchy with mix of sentence cases and camel case, etc. The outline is not rendering properly and not linking correctly in some cases. Have an overall look and improve this section.

### ✏️ Suggested improvement

_No response_

### 📌 Additional context

_No response_

Contributor guide

Open the contributing guide

Research direction

Open the affected examples page at https://fluent.docs.pyansys.com/version/dev/examples/index.html and inspect its headings, sentence and camel case usage, outline, and links. Review the documentation source that generates this section, then confirm the examples render consistently and the outline and links work correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.