Skip to content

docs: document OCI usage patterns and directory contents#10

Merged
castrojo merged 2 commits intomainfrom
document-oci-usage
Nov 16, 2025
Merged

docs: document OCI usage patterns and directory contents#10
castrojo merged 2 commits intomainfrom
document-oci-usage

Conversation

@castrojo
Copy link
Contributor

Updates the README with comprehensive documentation on how to consume this OCI layer.

Changes

  • Added clear explanation of what's inside the layer
  • Documented major components in /etc/ublue-os/ and /usr/share/ublue-os/
  • Provided three usage examples for Containerfiles:
    • Copy all system files
    • Copy only /etc configuration
    • Copy only /usr configuration
  • Added local build instructions
  • Improved overall structure and clarity

This makes it easier for consumers (like bluefin and bluefin-lts) to understand what this layer contains and how to use it effectively in their builds.

Add comprehensive usage examples showing how to consume this OCI layer
in Containerfiles. Documents three patterns:
- Copy all system files
- Copy only /etc configuration
- Copy only /usr configuration

Also documents major components in each directory without listing
individual files.

Assisted-by: Claude 3.5 Sonnet via GitHub Copilot
Removed unnecessary bullet points and improved formatting for clarity.
@castrojo castrojo merged commit 8cff08b into main Nov 16, 2025
1 check passed
@castrojo castrojo deleted the document-oci-usage branch January 4, 2026 06:06
@castrojo castrojo added the kind/documentation Improvements or additions to documentation label Jan 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant