obsidianmd / obsidian-help

Help documentation for Obsidian.
https://help.obsidian.md
1.12k stars 357 forks source link

Add graphic of app UI components (Desktop) #437

Open trainbuffer opened 1 year ago

trainbuffer commented 1 year ago

A graphic somewhere in the help documentation showing the different areas of the Obsidian interface would be a welcome addition and aid in use and troubleshooting. I understand a quality graphic takes time and talent to make and is another thing to maintain, but I think it could benefit everyone.

Here's an older example courtesy of Commander (https://github.com/phibr0/obsidian-commander): commander-layout

Here is one courtesy of Nick Milo (from Discord): nikmilo-layout

marcusolsson commented 1 year ago

This would be helpful for sure.

Previously, we've been avoiding graphics in the Help docs, since it was being shipped with Obsidian and we didn't want to increase the download size.

AFAIK, we don't ship the Help docs with Obsidian anymore so we should reconsider adding this.

sigrunixia commented 3 months ago

@kepano Would you be willing to take a swing at this in Figma?

trainbuffer commented 3 months ago

Someone recently asked for a "diagram labeling the different parts of the default Obsidian screen layout" and I pointed to the examples here, but in having a look around, I noticed there's an older image on the dev docs site: https://docs.obsidian.md/Plugins/User+interface/About+user+interface.

Although dev focused (mentioning the View areas) and pre Obsidian v1.0, it's another example of a possible way to go.

user-interface