Docs

[sharhar]

Summary by CodeRabbit

• Documentation

  • Refreshed Getting Started structure and added a development-status warning.
  • Updated buffer tutorial to use multi-device buffers and the asbuffer workflow; added Buffer API reference.
  • Revamped context tutorial with a global context model, initialization guidance, LogLevel details, and context management examples; streamlined API references.
  • Added Data Types Overview with supported types and related API references.
  • Added Logging overview and API reference.
  • Updated tutorials index to include new pages.

• Chores

  • Docs deployment workflow now installs numpy to ensure successful documentation builds.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds numpy installation to the docs deploy workflow. Updates README and getting_started headings. Substantial tutorial docs rework: buffers now described as multi-device with asbuffer API, context management clarified, and new pages for data types and logging. Updates tutorials index to include new pages.

Changes

Cohort / File(s)	Summary of changes
Docs deploy workflow .github/workflows/deploy_docs.yml	Adds "pip install numpy" to the Install build dependencies step; no other step changes.
Top-level getting started docs README.md, docs/getting_started.rst	Renames headers (split “Getting Started/Installation” into “Getting Started” + “Installation”); adds a warning banner in README; no content changes to install instructions.
Buffers tutorial and API refs docs/tutorials/buffer_tutorial.rst	Reframes buffers as multi-device by default; removes BufferBuilder; documents and references vkdispatch.asbuffer; adds Buffer API reference with Buffer methods and read semantics.
Context tutorial and API refs docs/tutorials/context_system.rst	Reorganizes around a global/default context; adds context management examples; documents vd.initialize, vkdispatch.make_context, LogLevel; removes vkdispatch.get_context docs; retitles API sections.
New tutorials pages docs/tutorials/data_types.rst, docs/tutorials/logging.rst	Adds Data Types overview with API references for dtypes and helpers; adds Logging overview with vkdispatch.LogLevel reference.
Tutorials index docs/tutorials/index.rst	Renames title to “Tutorials”; adds toctree entries for data_types and logging.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as GitHub Actions Runner
  participant Job as Deploy Sphinx Docs Job
  participant Py as Python Env

  Dev->>Job: Start workflow (push to docs branch)
  Job->>Py: Install Sphinx and sphinx-rtd-theme
  Note right of Py: New step added
  Job->>Py: pip install numpy
  Job->>Job: Build Sphinx docs
  Job-->>Dev: Publish documentation

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nudge the docs with twitching nose,
New paths for buffers, context grows.
I hop through logs, dtype meadows green,
Install numpy—slick and clean.
With ears perked high, I ship with cheer,
Tutorials tidy, carrots near. 🥕✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d67d035 and 678bbc8.

📒 Files selected for processing (8)

• .github/workflows/deploy_docs.yml (1 hunks)
• README.md (1 hunks)
• docs/getting_started.rst (2 hunks)
• docs/tutorials/buffer_tutorial.rst (2 hunks)
• docs/tutorials/context_system.rst (3 hunks)
• docs/tutorials/data_types.rst (1 hunks)
• docs/tutorials/index.rst (2 hunks)
• docs/tutorials/logging.rst (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}