search

godotengine / godot-proposals

Godot Improvement Proposals (GIPs)
MIT License
1.16k stars 97 forks source link

Improve Usability of Documentation within Script Editor #9912

Open Bimbam360 opened 5 months ago

Bimbam360 commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

Related: https://github.com/godotengine/godot-proposals/issues/7233

Bimbam360 commented 5 months ago

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 commented 5 months ago

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 commented 3 months ago

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 commented 2 months ago

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