Skip to content

Sync README, ROADMAP, and CLAUDE.md docs from DLaneAtElekta fork#8

Open
DLaneAtElekta wants to merge 4 commits into
dg1an3:masterfrom
DLaneAtElekta:master
Open

Sync README, ROADMAP, and CLAUDE.md docs from DLaneAtElekta fork#8
DLaneAtElekta wants to merge 4 commits into
dg1an3:masterfrom
DLaneAtElekta:master

Conversation

@DLaneAtElekta
Copy link
Copy Markdown

Promotes 4 commits from DLaneAtElekta/SRODecoderRing:master (fast-forward over dg1an3/SRODecoderRing:master, last touched 2023).

What's included

  • New CLAUDE.md for AI-assistant context
  • Improved README.md
  • New ROADMAP.md

Why this PR

Reconciling the two-account fork pair so dg1an3 (designated primary) carries the latest work.

claude and others added 4 commits October 28, 2025 23:31
This file provides comprehensive context about the SRODecoderRing project for
AI assistants, including:
- Project overview and domain context (DICOM/radiotherapy)
- Multi-language architecture (Python/F#/C#)
- Tech stack and dependencies
- Project structure and key components
- Development workflow and common tasks

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
…CUaTzJySJegRP5MHvhqoo

Add CLAUDE.md documentation for AI assistant context
Major improvements to project documentation:

README.md enhancements:
- Add professional project overview with problem/solution framing
- Include badges for license, Python version, and PyTorch
- Add comprehensive Quick Start guide with installation steps
- Document architecture with ASCII diagram
- Expand tech stack details for Python, .NET, and Web components
- Add clear project structure with descriptions
- Include development workflow for training and deployment
- Add domain context explanations (DICOM, SRO, rotation orders)
- Add contributing guidelines emphasizing patient safety
- Add medical device disclaimer for regulatory clarity

New ROADMAP.md:
- Document current project status and capabilities
- List known issues requiring immediate attention
- Short-term improvements (Q1-Q2 2025): docs, testing, CI/CD
- Medium-term enhancements (Q3-Q4 2025): features, architecture
- Long-term vision (2026+): advanced ML, clinical integration
- Performance targets and version milestones
- Clear timeline and contribution guidelines

Both documents provide much better context for developers,
contributors, and users while maintaining the project's unique
voice about using ML as a "sledgehammer solution" to the
insidious SRO interpretation problem.
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.

2 participants