Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation: Dynamic dispatch / type conformances #6073

Open
ccummingsNV opened this issue Jan 13, 2025 · 6 comments
Open

Missing documentation: Dynamic dispatch / type conformances #6073

ccummingsNV opened this issue Jan 13, 2025 · 6 comments
Assignees
Labels
goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang kind:documentation areas where we can improve documentation in codebase

Comments

@ccummingsNV
Copy link
Contributor

No description provided.

@bmillsNV bmillsNV added kind:documentation areas where we can improve documentation in codebase goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang labels Jan 16, 2025
@bmillsNV bmillsNV added this to the Q1 2025 (Winter) milestone Jan 16, 2025
@cheneym2
Copy link
Collaborator

What documentation is needed beyond https://shader-slang.org/docs/compilation-api/#dynamic-dispatch ?

Do we need content in the user guide perhaps?

@mkeshavaNV
Copy link
Contributor

@ccummingsNV - Can you please help answer what exactly you're looking for?

@csyonghe
Copy link
Collaborator

I think the documentation that @cheneym2 shared is sufficient. The problem I see is that it is not discoverable from the user-guide tree.

What really should be done here is to unify our docs into a single tree, instead of separated in user-guide, docs/ etc. We are planing to move all of our documentation to readthedocs.io in the next quarter, so this should come naturally as a part of that effort.

@ccummingsNV
Copy link
Contributor Author

As Yong says, I searched but couldn't find that so I assumed it was undocumented. You hit it doubly, as the main site says that the user guide describes the compilation api, and the user guide does contain that (https://shader-slang.org/slang/user-guide/compiling.html#using-the-compilation-api).

At a minimum, if it's a quick fix, why not update the 'compilation api' section in the user guide with a minimal section that describes what it is, and links to that full documentation for more info?).

@ccummingsNV
Copy link
Contributor Author

Side note: once we start linking docs together there's an interesting question with things like type-conformances / dynamic dispatch and slangpy/sgl. They are 2 sides of the same coin, and the documentation should at least link together, with examples that show both in tandem.

@bmillsNV bmillsNV assigned aidanfnv and unassigned mkeshavaNV Mar 18, 2025
@bmillsNV
Copy link
Collaborator

Moving to @aidanfnv - let's get the docs cleaned up and moved to readthedocs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
goal:quality & productivity Quality issues and issues that impact our productivity coding day to day inside slang kind:documentation areas where we can improve documentation in codebase
Projects
None yet
Development

No branches or pull requests

6 participants