chore(docs): Update documentation structure#174
Merged
Conversation
✅ Coverage Report📊 View Full HTML Report (download artifact) Overall Coverage
No Rust files changed in this PR. Generated by cargo-llvm-cov · Latest main coverage Last updated: 2026-02-07 00:37:49 UTC · Commit: |
There was a problem hiding this comment.
Pull request overview
This PR reorganizes lambda-rs specifications and tutorials into feature-based subdirectories (rendering/audio/runtime) and updates indexes and references so navigation remains consistent after the move.
Changes:
- Add/refresh docs indexes (
docs/specs/README.md,docs/tutorials/README.md) to group content by feature area and point to new paths. - Update references in top-level docs (
README.md,CONTRIBUTING.md) and spec template guidance (docs/specs/_spec-template.md) to reflect the new structure. - Refresh
last_updatedmetadata across moved/affected spec and tutorial documents.
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/rendering/techniques/reflective-room.md | Update metadata (last_updated). |
| docs/tutorials/rendering/techniques/offscreen-post.md | Update metadata (last_updated). |
| docs/tutorials/rendering/techniques/instanced-quads.md | Update metadata (last_updated). |
| docs/tutorials/rendering/techniques/indexed-draws-and-multiple-vertex-buffers.md | Update metadata (last_updated). |
| docs/tutorials/rendering/resources/uniform-buffers.md | Update metadata (last_updated). |
| docs/tutorials/rendering/resources/textured-quad.md | Update metadata (last_updated). |
| docs/tutorials/rendering/resources/textured-cube.md | Update metadata (last_updated). |
| docs/tutorials/rendering/basics/immediates-multiple-triangles.md | Update metadata (last_updated). |
| docs/tutorials/rendering/basics/basic-triangle.md | Update metadata (last_updated). |
| docs/tutorials/README.md | Rebuild tutorials index by feature/level; update metadata/version and changelog entry. |
| docs/specs/runtime/component-event-handling.md | Update metadata and fix internal checklist references to new spec path. |
| docs/specs/rendering/uniform-buffers-and-bind-groups.md | Update metadata and fix checklist reference to new spec path. |
| docs/specs/rendering/textures-and-samplers.md | Update metadata (last_updated). |
| docs/specs/rendering/offscreen-render-targets-and-multipass.md | Update metadata (last_updated). |
| docs/specs/rendering/instanced-rendering.md | Update metadata (last_updated). |
| docs/specs/rendering/indexed-draws-and-multiple-vertex-buffers.md | Update metadata (last_updated). |
| docs/specs/rendering/depth-stencil-msaa.md | Update metadata (last_updated). |
| docs/specs/audio/audio-file-loading.md | Update metadata (last_updated). |
| docs/specs/audio/audio-devices.md | Update metadata (last_updated). |
| docs/specs/_spec-template.md | Update authoring guidance to place specs under area folders and update the specs index. |
| docs/specs/README.md | Add a new specs index grouped by feature area with links to new paths. |
| README.md | Update tutorial deep link to new tutorial location. |
| CONTRIBUTING.md | Add guidance to place new specs under area folders and register them in docs/specs/README.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Organize
lambda-rsspecifications and tutorials into feature-based subdirectories (rendering/audio/runtime).Related Issues
Changes
docs/specs/rendering/docs/specs/audio/docs/specs/runtime/docs/tutorials/rendering/basics/docs/tutorials/rendering/resources/docs/tutorials/rendering/techniques/docs/specs/README.mdnow groups specs by feature area and links to the new paths.docs/tutorials/README.mdnow groups tutorials by feature area/level and links to the new paths.README.mdtutorial links updated.CONTRIBUTING.mdupdated with new specs organization guidance.docs/specs/_spec-template.mdupdated to instruct placing specs under area folders and adding them to the specs index.Type of Change
Affected Crates
lambda-rslambda-rs-platformlambda-rs-argslambda-rs-loggingChecklist
cargo +nightly fmt --all)cargo clippy --workspace --all-targets -- -D warnings)cargo test --workspace)Testing
N/A
Screenshots/Recordings
N/A (documentation move/link updates only).
Platform Testing
Additional Notes