Fix some documentation links#956
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR fixes broken documentation links across several README and documentation files. The changes remove invalid or malformed links while preserving the essential content and references.
Key Changes:
- Removed broken markdown links that referenced non-existent files
- Cleaned up malformed URLs and link formatting
- Consolidated multi-line text that was incorrectly split
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| examples/scaling/README.md | Removed broken markdown link to case.py while keeping descriptive text |
| examples/nD_perfect_reactor/README.md | Removed malformed URL from academic reference |
| examples/2D_lid_driven_cavity/README.md | Removed broken YouTube video link |
| docs/documentation/getting-started.md | Removed broken markdown link to Aptitude wiki |
| docs/documentation/case.md | Consolidated split sentence and improved readability |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
User description
Fixes some broken links in the documentation.
PR Type
Documentation
Description
Fix broken documentation links and references
Remove invalid YouTube video link
Clean up formatting and text flow
Update reference formatting in examples
File Walkthrough
case.md
Improve text formatting and flowdocs/documentation/case.md
getting-started.md
Remove broken Aptitude linkdocs/documentation/getting-started.md
README.md
Remove broken YouTube video linkexamples/2D_lid_driven_cavity/README.md
README.md
Fix broken DOI reference linkexamples/nD_perfect_reactor/README.md
README.md
Remove broken case.py linkexamples/scaling/README.md