ansys / ansys/pyfluent

Document that users should disregard all unofficial PyFluent documentation

Open
#4,604 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

Promote our doc as the signal source of truth. Let users know that the official PyFluent doc is properly maintained and that we are aware of the potential existence of external cheat sheets, handouts and casual write-ups that are unlikely to be correct or up to date. Make this information prominent.

Contributor guide

Open the contributing guide

Research direction

No documentation file or entry point is named; first locate the official PyFluent documentation landing page and its source. Add a prominent notice directing users to the maintained official documentation and warning about unofficial material, then verify the documentation displays the notice.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.