Skip to content

chore(docs): Update documentation structure#174

Merged
vmarcella merged 2 commits intomainfrom
vmarcella/organize-documentation
Feb 7, 2026
Merged

chore(docs): Update documentation structure#174
vmarcella merged 2 commits intomainfrom
vmarcella/organize-documentation

Conversation

@vmarcella
Copy link
Member

Summary

Organize lambda-rs specifications and tutorials into feature-based subdirectories (rendering/audio/runtime).

Related Issues

Changes

  • Move specs into feature subdirectories:
    • Rendering: docs/specs/rendering/
    • Audio: docs/specs/audio/
    • Runtime/events: docs/specs/runtime/
  • Move tutorials into feature subdirectories:
    • docs/tutorials/rendering/basics/
    • docs/tutorials/rendering/resources/
    • docs/tutorials/rendering/techniques/
  • Update indexes:
    • docs/specs/README.md now groups specs by feature area and links to the new paths.
    • docs/tutorials/README.md now groups tutorials by feature area/level and links to the new paths.
  • Update references to moved docs:
    • README.md tutorial links updated.
    • CONTRIBUTING.md updated with new specs organization guidance.
    • docs/specs/_spec-template.md updated to instruct placing specs under area folders and adding them to the specs index.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • Feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (updates to docs, specs, tutorials, or comments)
  • Refactor (code change that neither fixes a bug nor adds a feature)
  • Performance (change that improves performance)
  • Test (adding or updating tests)
  • Build/CI (changes to build process or CI configuration)

Affected Crates

  • lambda-rs
  • lambda-rs-platform
  • lambda-rs-args
  • lambda-rs-logging
  • Other:

Checklist

  • Code follows the repository style guidelines (cargo +nightly fmt --all)
  • Code passes clippy (cargo clippy --workspace --all-targets -- -D warnings)
  • Tests pass (cargo test --workspace)
  • New code includes appropriate documentation
  • Public API changes are documented
  • Breaking changes are noted in this PR description

Testing

N/A

Screenshots/Recordings

N/A (documentation move/link updates only).

Platform Testing

  • macOS
  • Windows
  • Linux

Additional Notes

  • This PR changes doc file paths; any external deep links to the old locations will break and should be updated.

@vmarcella vmarcella requested a review from Copilot February 7, 2026 00:37
@github-actions
Copy link

github-actions bot commented Feb 7, 2026

✅ Coverage Report

📊 View Full HTML Report (download artifact)

Overall Coverage

Metric Value
Total Line Coverage 45.12%
Lines Covered 5012 / 11107

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: 36f8135

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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_updated metadata 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.

@vmarcella vmarcella merged commit b96df38 into main Feb 7, 2026
16 checks passed
@vmarcella vmarcella deleted the vmarcella/organize-documentation branch February 7, 2026 01:07
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