docs: Update ReadME #4477
Merged
docs: Update ReadME #4477
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prmukherj
requested review from
hpohekar,
mkundu1 and
seanpearsonuk
as code owners
github-actions
bot
added
the
documentation
|
Please provide any suggestions as required. |
Closed
seanpearsonuk
approved these changes
Sep 19, 2025
hpohekar
approved these changes
Sep 19, 2025
There was a problem hiding this comment.
Pull Request Overview
Updates the README documentation to simplify the basic usage examples and remove references to deprecated components. The changes focus on making the documentation more concise and current.
- Replaced TUI-specific code examples with a simpler solver_session launch example
- Removed reference to PyFluent Parametric library
- Updated language for PyFluent Visualization description
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/changelog.d/4477.documentation.md | Adds changelog entry for README update |
| README.rst | Removes TUI examples, parametric repo reference, and simplifies documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update ReadME
Remove reference to parametric repo.
Update code to not show tui usage.