Skip to content

docs: update documentation for new architecture#125

Draft
cmagina wants to merge 1 commit intoredhat-et:mainfrom
cmagina:pr-11-documentation-updates
Draft

docs: update documentation for new architecture#125
cmagina wants to merge 1 commit intoredhat-et:mainfrom
cmagina:pr-11-documentation-updates

Conversation

@cmagina
Copy link
Copy Markdown
Collaborator

@cmagina cmagina commented Feb 7, 2026

Summary

This PR is part 11 of 11 in the rework modernization effort. It updates all documentation to reflect the new architecture and features.

Changes:

  • ✅ Update README.md for new architecture
  • ✅ Update .devcontainer/devcontainer.md for new variants

README.md updates:

  • New image naming (cpu, cuda, rocm vs triton-*)
  • Document INSTALL_* environment variables for all frameworks
  • Updated build and run command examples
  • New Makefile targets and options
  • Information about modular setup scripts
  • Improved organization and clarity

.devcontainer/devcontainer.md updates:

  • New variant names (cpu, cuda, rocm)
  • Updated devcontainer structure
  • Revised examples and usage instructions

Why this change?

After all the architectural changes in PRs #115-124, the documentation
needs to be updated to:

  • Accurately reflect the new structure
  • Help users understand new features and options
  • Provide clear examples of the new commands
  • Ensure consistency between code and docs

Testing:

  • Documentation reviewed for accuracy
  • All examples verified against new Makefile targets
  • Links and references checked

Dependencies:

Completes:
This is the final PR in the 11-part rework modernization series.
Once merged (along with all dependencies), the rework will be complete.

🤖 Generated with Claude Code

Update all documentation to reflect the modernized architecture
and new features:

README.md changes:
- Update for new image naming (cpu, cuda, rocm vs triton-*)
- Document new INSTALL_* environment variables
- Add documentation for all framework setup options
- Update build and run command examples
- Document new Makefile targets and options
- Add information about modular setup scripts
- Improve organization and clarity

.devcontainer/devcontainer.md changes:
- Update for new variant names (cpu, cuda, rocm)
- Reflect changes in devcontainer structure
- Update examples and usage instructions

Benefits:
- Ensures documentation matches the new architecture
- Helps users understand the new features and options
- Provides clear migration guidance
- Improves overall documentation quality

This documentation update completes the rework modernization
by ensuring all user-facing documentation accurately reflects
the changes from PRs redhat-et#115-124.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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