Bump version to 0.0.7 and enhance documentation and API clarity#26
Merged
Conversation
Updated the Version field in NuGet.Packaging.props from 0.0.6 to 0.0.7 to prepare for the next release. No other changes were made.
Clarify API versions (DirectX 12, Metal 4, Vulkan 1.4) throughout docs, tables, and code comments. Refactor backend selection logic for correct platform mapping. Update resource binding helper and ray tracing samples for accuracy. Improve table formatting and header link visibility in CSS. Expand design philosophy to explain backend version choices.
- Streamlined bug report template by merging sections and clarifying environment details; updated placeholders to specify API versions (DirectX 12, Metal 4, Vulkan 1.4). - Removed general issue template (custom.yaml) and "Feature Discussions" contact link, directing general queries to Discussions. - Updated NuGet package description and tags to reflect precise supported API versions.
Reorder platform checks in App.cs for backend/surface selection. Standardize documentation and UI to use "Windows, macOS, Linux". Fix minor typos and clarify backend binding notes in docs. No functional changes; improves clarity and consistency.
Broadened the <PackageTags> entry in NuGet.Packaging.props by replacing "Metal4" with "Metal" to refer to all versions of Metal, not just version 4. This improves discoverability and accuracy of the package metadata.
Added Silk.NET.MoltenVK.Native (v2.23.0) to enable MoltenVK, improving Vulkan compatibility on macOS. Updated both Directory.Packages.props and Zenith.NET.Vulkan.csproj to include the new package dependency.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR bumps Zenith.NET to v0.0.7 and refreshes project-facing documentation/UX to more clearly communicate backend/API targets (DirectX 12, Metal 4, Vulkan 1.4), platform support, and improve the generated docs site experience (layout + search).
Changes:
- Version bump to
0.0.7and updated/standardized backend naming across docs/landing pages. - Documentation site improvements (DocFX config, CSS layout tweaks, and enhanced in-site search behavior).
- Community process updates (simplified issue templates) and Vulkan-on-Apple enablement work (MoltenVK native dependency).
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
sources/Zenith.NET.Vulkan/Zenith.NET.Vulkan.csproj |
Adds MoltenVK native dependency for Vulkan-on-Apple scenarios. |
sources/Directory.Packages.props |
Central package version entry for Silk.NET.MoltenVK.Native. |
sources/NuGet.Packaging.props |
Bumps package version to 0.0.7. |
sources/Experiments/CornellBox/App.cs |
Adjusts OS→backend/surface selection (Windows DX12, macOS Metal, otherwise Vulkan). |
sources/Experiments/CornellBox/CONVENTIONS.md |
Updates backend naming/order in CornellBox conventions. |
README.md |
Standardizes backend/version naming and updates platform support table. |
documents/index.md |
Landing page copy updated to new backend/version naming and platform ordering. |
documents/docs/index.md |
Adds “Design Philosophy” section and refreshes platform support table headings. |
documents/docs/concepts/graphics-context.md |
Updates backend naming/version wording for consistency. |
documents/api/index.md |
Clarifies backend versioning in API namespace table descriptions. |
documents/tutorials/index.md |
Reorders desktop platform listing for consistency. |
documents/tutorials/getting-started/prerequisites.md |
Updates platform/backend selection narrative and reorganizes some tutorial content. |
documents/tutorials/advanced/ray-tracing.md |
Fixes/clarifies ray query sphere intersection snippet variables. |
documents/docfx.json |
Enables search, adds sitemap config, and sets enum sort order to declaring order. |
documents/templates/public/main.css |
Improves docs layout (full-width), table formatting, and search results styling. |
documents/templates/public/main.js |
Adds table-cell nowrap behavior and custom search navigation/back behavior. |
.github/ISSUE_TEMPLATE/bug_report.yaml |
Simplifies bug report fields and guidance text. |
.github/ISSUE_TEMPLATE/config.yml |
Removes “Feature Discussions” link and tidies contact links. |
.github/ISSUE_TEMPLATE/custom.yaml |
Removes the “General Issue” template. |
Comments suppressed due to low confidence (1)
.github/ISSUE_TEMPLATE/bug_report.yaml:37
- The environment placeholder still references "DirectX12 / Metal / Vulkan" and a hardcoded "Zenith.NET Version: 1.0.0". This conflicts with the repo’s standardized API naming (DirectX 12 / Metal 4 / Vulkan 1.4) and the current package version (0.0.7). Updating these placeholders will reduce confusion in incoming bug reports.
placeholder: |
- OS: Windows 11 / macOS 15 / Ubuntu 24.04 / etc.
- Graphics API: DirectX12 / Metal / Vulkan
- Zenith.NET Version: 1.0.0
- GPU: NVIDIA RTX 4090 / Apple M3 / etc.
💡 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.
This pull request focuses on improving documentation clarity, updating backend/version references, refining issue templates, and enhancing the website's user experience. The most significant changes include standardizing the naming and versioning of supported graphics APIs (DirectX 12, Metal 4, Vulkan 1.4), updating platform support information, simplifying issue templates, and improving the documentation site's layout and search functionality.
Documentation and Branding Updates:
README.md, documentation index files, and landing pages. This includes feature lists, overviews, and API reference tables. [1] [2] [3] [4] [5] [6] [7] [8]Issue Template and Community Process Improvements:
Documentation Site Enhancements:
docfx.json) to sort enums by declaration order, enable search, and generate a sitemap for improved SEO and usability. [1] [2]These changes collectively enhance the professionalism, usability, and clarity of the Zenith.NET documentation and community processes.