Skip to content

docs: Rename OSDC to ODC and improve documentation#43

Open
wdvr wants to merge 1 commit into
mainfrom
docs/rename-to-odc-and-improve-docs
Open

docs: Rename OSDC to ODC and improve documentation#43
wdvr wants to merge 1 commit into
mainfrom
docs/rename-to-odc-and-improve-docs

Conversation

@wdvr
Copy link
Copy Markdown
Owner

@wdvr wdvr commented Mar 4, 2026

Summary

This PR updates all documentation to reflect the project rename from OSDC to ODC (Open Dev Cloud) and adds comprehensive improvements to make the project more accessible.

Changes

New Files:

  • README.md - Professional project README with quick start, features overview, and links to detailed docs
  • Links to internal documentation site: odc-docs.nest.x2p.facebook.net (once deployed)

Updated Files:

  • docs/USER_GUIDE.md - Renamed OSDC → ODC, added missing disk commands (clone, unlock), documented all edit command options
  • cli-tools/gpu-dev-cli/README.md - Renamed OSDC → ODC, added missing disk commands

Documentation Completeness:

  • Added disk clone and unlock commands
  • Documented all gpu-dev edit options: --enable-jupyter, --disable-jupyter, --add-user, --extend
  • Improved command reference tables
  • Added feature highlights and getting-started guidance

Impact

  • Clearer project identity (ODC instead of OSDC)
  • Better onboarding experience with comprehensive README
  • Complete documentation of all CLI features
  • Professional presentation for GitHub repository

Test Plan

  • Verified all markdown files render correctly
  • Confirmed all command examples are accurate
  • Checked internal links work
  • README provides clear getting-started path

- Add comprehensive README.md to repository root
- Rename project from OSDC to "ODC (Open Dev Cloud)"
- Add link to internal docs site: odc-docs.nest.x2p.facebook.net
- Document missing disk management commands (clone, unlock)
- Document all edit command options (enable-jupyter, disable-jupyter, add-user, extend)
- Improve CLI command reference completeness
- Add getting-started guidance and feature highlights
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