docs(scripting): add VertexBuffer and TriangleBuffer reference pages - #884
Open
neurowave wants to merge 3 commits into
Open
docs(scripting): add VertexBuffer and TriangleBuffer reference pages#884neurowave wants to merge 3 commits into
neurowave wants to merge 3 commits into
Conversation
drawImageMesh takes both types, but neither had a page, so the signature named types the reader could not look up. Every other Renderer method links its parameter types. Content is taken from the Luau declarations in scripting_workspace builtins.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Use Methods rather than Fields for the two methods, add the signature comments every other page carries above the signature block, and drop the constructor prose; ImageSampler is constructed the same way and introduces itself with a code block alone.
The api-reference groups run alphabetically; Mesh was inserted after Path instead of between Mat4 and Paint.
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
1 participant
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.
Renderer.drawImageMeshtakesVertexBufferandTriangleBuffer:Neither type had a page, so the signature named types you couldn't look up. Every other Renderer method links its parameter types:
drawPathlinks Path and Paint,drawImagelinks Image, ImageSampler, and BlendMode.Adds a page for each with their
addandresetmethods, a Mesh group in the sidebar, and links from thedrawImageMeshdescription.Content comes from the Luau declarations in
scripting_workspacebuiltins. Page structure follows the existing reference pages:## Methods, the{/* */}signature comment above each signature block, and a code block rather than constructor prose, matching ImageSampler, which is constructed the same way.mint broken-linkspasses.