DCM Notes for 2024-06-17

[glopesdev]

Proposals

• Proposal for new editor navigation model #1823
• Consider customizing API documentation processor for combinators docs#85

[glopesdev]

Navigation Model

@bruno-f-cruz suggested adding the ability to pin/unpin specific paths to the explorer, similar to Windows Quick Access.
@NeuroThom suggested being able to copy nodes from the explorer window directly (similar thing with properties).

We need to discuss shortcut keys for navigation:

• previous level
• next level
• go up a level

Consider having a "temporary" working tab for quickly browsing through levels. One suggestion is to have this working tab always be the first one on the left.

Consider using meta-navigation for explorer-like windows similar to VS Code with collapsible sections. In our case these would be Toolbox, Explorer, etc.

Something else to think about is where to store editor settings such as opened tabs, currently selected level, etc. Since there will now be potentially many more state to save this will be important. Alternatives are save it locally to the project, e.g. .config folder, at the level of the environment, or system-wide.

Documentation Structure

• Friendlier frontend page for operators instead of C#-centric page:
  1. Two separate entry points for friendly-docs and c#-docs
     • pros: complete separation from technical bits and pieces of c# classes
     • cons: quite often it happens that enums and accessory classes/structs need to be understood to be able to master the use of the package successfully
  2. Combined entry point with specific sub-sections for operator docs
     • pros: keep privileged entry point for operators if we place them as a separate category at the top of every namespace
     • cons: other types will still be visible
• Automatically generate placeholder workflow resource to allow copying the operator directly from its docs page
• Create custom DocFX document processor for more flexible processing of different operator types