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 graphic of app UI components #437

Open
trainbuffer opened this issue Apr 8, 2023 · 3 comments
Open

Add graphic of app UI components #437

trainbuffer opened this issue Apr 8, 2023 · 3 comments
Assignees
Labels
enhancement Indicates new item to be added to the docs. help wanted Extra attention is needed for this issue or PR

Comments

@trainbuffer
Copy link

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
Copy link
Contributor

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.

@marcusolsson marcusolsson added the refactor Issues and PRs related to refactoring documentation, such as style enhancements. label May 5, 2023
@ericaxu ericaxu removed the refactor Issues and PRs related to refactoring documentation, such as style enhancements. label Aug 2, 2023
@ericaxu ericaxu changed the title [suggestion] Add a graphic showing different parts of the UI to help docs Add graphic of app UI components Aug 2, 2023
@sigrunixia sigrunixia self-assigned this Sep 28, 2023
@sigrunixia sigrunixia added this to the v1.6 milestone Dec 24, 2023
@sigrunixia sigrunixia modified the milestones: v1.5.8, Catchup Feb 22, 2024
@sigrunixia sigrunixia modified the milestones: Next, Soon May 2, 2024
@sigrunixia
Copy link
Contributor

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

@trainbuffer
Copy link
Author

trainbuffer commented Jul 25, 2024

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

@sigrunixia sigrunixia removed this from the Soon milestone Aug 8, 2024
@sigrunixia sigrunixia added help wanted Extra attention is needed for this issue or PR enhancement Indicates new item to be added to the docs. labels Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Indicates new item to be added to the docs. help wanted Extra attention is needed for this issue or PR
Projects
None yet
Development

No branches or pull requests

5 participants