Use relative repo paths in README#9
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to replace absolute local file paths with relative paths. The review feedback suggests using the ./ prefix for these relative paths to ensure they are explicitly relative and consistent throughout the document, along with a minor rephrasing for better flow.
| ``` | ||
|
|
||
| The app ships with a bundled sample file at [sample-network.json](/C:/Users/jdwil/source/repos/Codex/MedWNetworkSim/src/MedWNetworkSim.App/Samples/sample-network.json). | ||
| The app ships with a bundled sample file at [sample-network.json](src/MedWNetworkSim.App/Samples/sample-network.json). |
There was a problem hiding this comment.
The phrasing here is a bit redundant. For better flow, you could make the link text more descriptive and integrate it directly into the sentence. Also, prefixing the path with ./ makes it explicitly relative, which is good practice.
| The app ships with a bundled sample file at [sample-network.json](src/MedWNetworkSim.App/Samples/sample-network.json). | |
| The app ships with [a bundled sample file](./src/MedWNetworkSim.App/Samples/sample-network.json). |
| - [MainWindow.xaml](src/MedWNetworkSim.App/MainWindow.xaml) defines the main shell: canvas, summary panes, simulation results, and the in-app editor grids. | ||
| - [MainWindowViewModel.cs](src/MedWNetworkSim.App/ViewModels/MainWindowViewModel.cs) is the application coordinator. It loads/saves networks, keeps editor selections in sync, and triggers simulation. | ||
| - [NodeEditorWindow.xaml](src/MedWNetworkSim.App/NodeEditorWindow.xaml) provides the dedicated dropdown-driven node editing workflow. | ||
| - [NetworkFileService.cs](src/MedWNetworkSim.App/Services/NetworkFileService.cs) normalizes and validates JSON data and applies automatic layout. | ||
| - [NetworkSimulationEngine.cs](src/MedWNetworkSim.App/Services/NetworkSimulationEngine.cs) performs routing, capacity competition, bid-cost calculation, and consumer-cost summarization. |
There was a problem hiding this comment.
To make it explicit that these are relative paths and to improve consistency, it's good practice to prefix them with ./.
| - [MainWindow.xaml](src/MedWNetworkSim.App/MainWindow.xaml) defines the main shell: canvas, summary panes, simulation results, and the in-app editor grids. | |
| - [MainWindowViewModel.cs](src/MedWNetworkSim.App/ViewModels/MainWindowViewModel.cs) is the application coordinator. It loads/saves networks, keeps editor selections in sync, and triggers simulation. | |
| - [NodeEditorWindow.xaml](src/MedWNetworkSim.App/NodeEditorWindow.xaml) provides the dedicated dropdown-driven node editing workflow. | |
| - [NetworkFileService.cs](src/MedWNetworkSim.App/Services/NetworkFileService.cs) normalizes and validates JSON data and applies automatic layout. | |
| - [NetworkSimulationEngine.cs](src/MedWNetworkSim.App/Services/NetworkSimulationEngine.cs) performs routing, capacity competition, bid-cost calculation, and consumer-cost summarization. | |
| - [MainWindow.xaml](./src/MedWNetworkSim.App/MainWindow.xaml) defines the main shell: canvas, summary panes, simulation results, and the in-app editor grids. | |
| - [MainWindowViewModel.cs](./src/MedWNetworkSim.App/ViewModels/MainWindowViewModel.cs) is the application coordinator. It loads/saves networks, keeps editor selections in sync, and triggers simulation. | |
| - [NodeEditorWindow.xaml](./src/MedWNetworkSim.App/NodeEditorWindow.xaml) provides the dedicated dropdown-driven node editing workflow. | |
| - [NetworkFileService.cs](./src/MedWNetworkSim.App/Services/NetworkFileService.cs) normalizes and validates JSON data and applies automatic layout. | |
| - [NetworkSimulationEngine.cs](./src/MedWNetworkSim.App/Services/NetworkSimulationEngine.cs) performs routing, capacity competition, bid-cost calculation, and consumer-cost summarization. |
No description provided.