docs: enrich on-disk format documentation#13
Conversation
There was a problem hiding this comment.
Pull request overview
This PR restructures the EROFS on-disk format documentation by splitting the prior monolithic document into modular pages under src/ondisk/, and wires the new on-disk docs section into the existing Sphinx toctrees. It also adds a GitHub Actions workflow to build an HTML preview for PRs.
Changes:
- Introduce a new
src/ondisk/documentation section with separate pages for core format, compression, chunked format, and xattrs. - Update the design docs to point to the new on-disk docs index.
- Add a PR workflow to build and upload HTML documentation artifacts and comment instructions on the PR.
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/ondisk/index.md |
Adds a new on-disk format landing page and toctree for the modular docs. |
src/ondisk/core_ondisk.md |
Adds the new “core” on-disk format doc (superblock/inodes/directories) content. |
src/ondisk/compressed_format.md |
Adds a dedicated compressed format layout doc. |
src/ondisk/chunked_format.md |
Adds a dedicated chunk-based file format + device table doc. |
src/ondisk/xattrs.md |
Adds a dedicated xattrs doc (inline/shared/prefixes/filter/image-share). |
src/design.md |
Updates the design page toctree entry to point at ondisk/index. |
src/core_ondisk.md |
Removes the old monolithic on-disk doc at the prior location. |
.github/workflows/pr-preview.yml |
Adds a PR documentation preview workflow that builds HTML and posts artifact instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - name: Find existing comment | ||
| uses: peter-evans/find-comment@v3 | ||
| id: find-comment | ||
| with: | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| comment-author: 'github-actions[bot]' | ||
| body-includes: 'Documentation Preview' | ||
|
|
||
| - name: Create or update comment | ||
| uses: peter-evans/create-or-update-comment@v4 |
There was a problem hiding this comment.
Third-party actions peter-evans/find-comment@v3 and peter-evans/create-or-update-comment@v4 are referenced by moving tags. Consider pinning them to full commit SHAs to reduce supply-chain risk.
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@v5 | ||
| with: |
There was a problem hiding this comment.
This workflow uses several GitHub Actions by moving tags (e.g. actions/checkout@v4, actions/setup-python@v5). For supply-chain hardening, consider pinning actions (especially third-party ones) to full commit SHAs and documenting the update process.
Enrich the monolithic core_ondisk.md into modular files under src/ondisk/:
Remaining TBD: