ansys / ansys/pyfluent

Automatically clean up user guide & other docs

Open
#4,946 3 comments 0 reactions 1 assignee Claimed by @mayankansys View on GitHub
documentation
Dominant language
Python
Stars
497
Forks
77
Avg merge
22h 37m
Merged PRs (30d)
45

Description

## Overview

Some documentation is out of date or poorly structured — most notably around API modernisation. Rather than updating it piecemeal, **the goal is to express a clear set of quality criteria to Copilot (e.g. in VS Code) so it can do a full sweep and generate a git patch**.

## Quality Criteria & Known Violations

**Show only current, recommended usage patterns**
→ Text and coding examples use outdated API styles (e.g. `launch_fluent` invocation)

**Keep examples concise — users shouldn't wade through code to grasp a simple idea**
→ Some examples show fully expanded allowed-values output where this adds no value

**Stay on topic — don't explain unrelated features on a given page**
→ Solver settings allowed values are emphasised in the session management page

**Use plain, modern language without being excessively informal**
→ Some sections seem wordier than necessary

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.