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

Add Sandcastle links to documentation pages #12159

Open
jjspace opened this issue Aug 27, 2024 · 2 comments
Open

Add Sandcastle links to documentation pages #12159

jjspace opened this issue Aug 27, 2024 · 2 comments

Comments

@jjspace
Copy link
Contributor

jjspace commented Aug 27, 2024

We have a lot of really useful Sandcastle examples for how to use specific classes. Right now these are hard to discover unless you already know that Sandcastle exists. I think it would be really helpful to add links to sandcastles in the actual documentation alongside class and method definitions to try and help point more people to actual working examples for how to use them.

@lukemckinstry
Copy link
Contributor

Links from documentation would be helpful. Perhaps through a mechanism like tagging there is also a way to make the sandcastle examples searchable by something like a class name.

@jjspace
Copy link
Contributor Author

jjspace commented Sep 16, 2024

The search in sandcastle already searches in the code for every sandcastle itself. This means you can already search for class names and see sandcastles that use it. Some generic searches like Scene will give many results but a search like PostProcess will pull up the specific sandcastles that use the post process stage classes and features

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment