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

Improve Usability of Documentation within Script Editor #9912

Open
Bimbam360 opened this issue Jun 7, 2024 · 6 comments
Open

Improve Usability of Documentation within Script Editor #9912

Bimbam360 opened this issue Jun 7, 2024 · 6 comments

Comments

@Bimbam360
Copy link

Bimbam360 commented Jun 7, 2024

edit: I think I put this in the wrong category, as it should likely be under discussion before issue (can someone change it if needed). Also there are other existing conversations about much larger overhauls like #7233. To me this is a 'quick win' as decoupling documentation into it's own dockable window or similar should support such changes.

Describe the project you are working on

Any

Describe the problem or limitation you are having in your project

Built in documentation is available and shown within the Script Editor, which is fantastic. However, this always takes up the full Script Editor window (to my knowledge) making it inefficient to switch back and forth from Doc to Script, especially on larger screens:

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

Documentation should not be forced to share the same window space as scripts exclusively, preventing side by side comparison.

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

Ideally, decoupling Documentation from Scripts in such a way it could be separately detached or moved in the editor as a dockable window, allowing to do something like this in the Script Editor for example:

image

Not sold on this layout, I just mashed some screenshots together to make a point for discussion.

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

I'd need to hack up a full editor plugin which is non-trivial, and prone to change control issues between versions.

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

This improves the script editor experience out of the box.

@nobuyukinyuu
Copy link

Definitely if it would go in a place I could use it, it would be the tab area holding the output window. Maybe that area can host a split editor just for documentation...

@PLyczkowski
Copy link

Related: #7233

@Bimbam360
Copy link
Author

Definitely if it would go in a place I could use it, it would be the tab area holding the output window. Maybe that area can host a split editor just for documentation...

It should really be up to the user where they want to put it, so a detachable/dockable window would be ideal, but then ideally I would want dock options on the script editor window also.

@Changryy
Copy link

This probably shouldn't be limited to just documentation. I think a better solution would be if you could just generally have multiple script windows open at the same time like you can in most other code editors.

Docs could then either automatically be opened in the secondary window or there could be an engine setting to specify which window docs should be opened in.

@GreatTusk
Copy link

GreatTusk commented Aug 7, 2024

What about having a dedicated tab for documentation, right next to Scripts, maintaining the layout proposed here? I think it would be a convenient way to avoid having scripts and documentation mixed together

@marcinn
Copy link

marcinn commented Sep 9, 2024

it would be the tab area holding the output window. Maybe that area can host a split editor just for documentation...

and also allow to make it floating

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

7 participants