Skip to content

docs: review fixes, demo verification, and documentation overhaul - #10

Open
raghavnaidu1470-dotcom wants to merge 7 commits into
mainfrom
docs/review-fixes
Open

raghavnaidu1470-dotcom wants to merge 7 commits into
mainfrom
docs/review-fixes

Conversation

@raghavnaidu1470-dotcom

Copy link
Copy Markdown
Owner

Summary of Changes

This pull request implements the review fixes requested in the NetSim-X specification overhaul:

1. Name Change

  • Replaced Raghav with Ragghav Kamaraj across the entire repository for Member 1 (README.md, GETTING_STARTED.md, CONTRIBUTING.md, CODEOWNERS, STATUS.md, docs/*.md, network/__init__.py, and test files).
  • Preserved GitHub username raghavnaidu1470-dotcom and teammates Harish (Member 2) and Akhilesh Reddy (Member 3).

2. Dijkstra Demo Consistency

  • Updated README.md, docs/spec.md, docs/member1_network_engine.md, and data/topologies/why_shortest_is_not_best.json to explicitly designate Dijkstra (hop-count metric).
  • Documented that Dijkstra with a latency metric correctly chooses the optimal 5-hop path (36.0 ms), illustrating the classic shortest-hop-path pitfall.
  • Added pytest test case test_dijkstra_why_shortest_is_not_best_hop_vs_latency verifying both metrics.

3. Verified README Numbers for All 3 Demos

  • Computed and verified metrics across all 3 topologies using the simulation engine:
    • why_shortest_is_not_best.json: Hop Dijkstra yields PC1 -> R1 -> R2 -> R5 -> PC2 (4 hops, 79.0 ms, 82.0% congestion, 19.17% loss). XAR / Latency Dijkstra yields PC1 -> R1 -> R3 -> R4 -> R5 -> PC2 (5 hops, 36.0 ms, 12.0% congestion, 3.16% loss).
    • router_failure.json: Pre-failure route is PC1 -> R1 -> R2 -> PC2 (3 hops, 14.0 ms, 10.0% congestion, 0.70% loss). Post-failure route is PC1 -> R1 -> R3 -> R4 -> PC2 (4 hops, 44.0 ms, 15.0% congestion, 2.58% loss, recovery time: 350.0 ms).
    • traffic_profile_change.json: Candidate A (PC1 -> R1 -> R3 -> R4 -> PC2, 17.0 ms, 14.0% congestion, 14.61% loss, XAR score: 0.1458 vs 0.2085) selected for Real-Time traffic. Candidate B (PC1 -> R1 -> R2 -> R4 -> PC2, 69.0 ms, 8.0% congestion, 0.40% loss, XAR score: 0.0826 vs 0.1654) selected for Reliable Data traffic.

4. CI Workflow

  • Workflow file .github/workflows/test.yml authored and verified locally for Python 3.11 / 3.12 running pytest.
  • Local pytest run: 31 passed, 15 skipped in 0.96s (all Member 1 tests pass; 15 Member 2/3 tests skipped pending implementation).
  • Note on remote CI push: The active OAuth token lacks the GitHub workflow scope, preventing remote pushes that add or alter files under .github/workflows/. Run gh auth refresh -s workflow or create the workflow in GitHub web UI to trigger Actions.

5. Math Rendering

  • Ensured GitHub MathJax compatibility across README.md and docs/*.md by escaping underscores in LaTeX \text{} and \mathrm{} blocks.

6. Repository About Section

  • Configured via gh repo edit:
    • Description: Explainable adaptive routing and network resilience simulator (Python, NetworkX, Streamlit)
    • Topics: computer-networks, routing, networkx, streamlit, network-simulation, dijkstra, distance-vector, python

7. README Enhancements

  • Added Project Structure tree representing actual repository layout.
  • Added How Routing Works covering Link State / Dijkstra, Distance Vector, and XAR multi-criteria routing.
  • Added Traffic Profiles table with verified weights.
  • Added Resilience Flow Mermaid sequence diagram with real function names.
  • Added Algorithm Comparison section covering Race Mode metrics.
  • Updated Team Table with Member 1 as Ragghav Kamaraj.

8. STATUS.md Honesty Pass

  • Added Origin column: Member 1 (implemented) vs Scaffolded (AI) - owner to review and extend.
  • Marked unowned Member 2 and 3 modules as Scaffolded - pending owner review.

9. Documentation Cross-Check

  • Verified function signatures, relative file links, and branch references.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant