Skip to content

docs: document devcontainer tools and mounts - #23

Merged
mjun0812 merged 1 commit into
mainfrom
docs/devcontainer-tools
Sep 3, 2026
Merged

docs: document devcontainer tools and mounts#23
mjun0812 merged 1 commit into
mainfrom
docs/devcontainer-tools

Conversation

@mjun0812

Copy link
Copy Markdown
Owner

Overview and Background

Document the devcontainer tools, authentication mounts, and cache behavior in both the repository README and the generated-project README. Previously, the Devcontainer sections did not explain Codex availability, host authentication directories, or the persistence and write behavior of those mounts.

Related Issues

None.

Implementation Approach

Align the existing Devcontainer documentation with template/.devcontainer/devcontainer.json and template/.devcontainer/Dockerfile, keeping the changes limited to the two relevant README sections.

Changes

  • Document automatic installation of uv and Claude Code.
  • Document that the image build installs the latest Codex release and that rebuilding updates Codex.
  • Document the host ${HOME}/.claude and ${HOME}/.codex authentication bind mounts, including their read-write impact on host configuration.
  • Document the named uv cache volume and its reuse across container rebuilds.

Impact

This is a documentation-only change. It clarifies existing setup and the host-side effects of read-write bind mounts; runtime behavior is unchanged.

Validation Results

  • oxfmt --check README.md template/README.md — passed.
  • jq empty template/.devcontainer/devcontainer.json — passed.
  • git diff --check — passed.

- Describe Codex, Claude Code, and uv setup in both README files
- Document authentication bind mounts and their read-write host impact
- Explain uv cache volume persistence and Codex image rebuild updates
@mjun0812mjun0812 added the documentation Improvements or additions to documentation label Sep 2, 2026
@mjun0812mjun0812 self-assigned this Sep 2, 2026

@mjun0812mjun0812 left a comment

Copy link
Copy Markdown
OwnerAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex PR Review

Summary

This pull request documents the Dev Container tools, authentication bind mounts, host-side write behavior, and uv cache persistence in both README files. No blocking findings were confirmed. The Contract axis was skipped because no spec source was available.

Verdict

APPROVE

Findings

N/A


Reviewed by Codex at 868081f

@mjun0812
mjun0812 merged commit 083eb7c into mainSep 3, 2026
6 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mjun0812