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 a way to open a script from the script documentation page #11425

Open
pcvonz opened this issue Dec 26, 2024 · 2 comments
Open

Add a way to open a script from the script documentation page #11425

pcvonz opened this issue Dec 26, 2024 · 2 comments

Comments

@pcvonz
Copy link

pcvonz commented Dec 26, 2024

Describe the project you are working on

Nothing special

Describe the problem or limitation you are having in your project

Navigating to the source script from the documentation page.

Describe the feature / enhancement and how it helps to overcome the problem or limitation

A link from the documentation that opens up the script in the editor.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Screencast.From.2024-12-23.09-08-13.mp4

If this enhancement will not be used often, can it be worked around with a few lines of script?

No, the generated documentation will need to be modified.

Is there a reason why this should be core and not an add-on in the asset library?

Requires a change to the editor

@arkology
Copy link

Looks like you already have implementation, right?

@pcvonz
Copy link
Author

pcvonz commented Dec 28, 2024

@arkology Yeah! Something pretty basic. I need to do a couple things though:

  • figure out how the documentation generation works and make sure the links aren't added
  • Figure out what happens for documentation generated for resources (I thought I saw one of my shaders in the search help list, but I may have been mistaken?)

@Calinou Calinou changed the title Add a way to open a script from the script documentation page. Add a way to open a script from the script documentation page Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants