Skip to content

docs: Improve landing page with navigation and getting started links (#1134)#1181

Open
BradGroux wants to merge 1 commit into
obsidian-community:mainfrom
BradGroux:docs/improve-landing-page-1134
Open

docs: Improve landing page with navigation and getting started links (#1134)#1181
BradGroux wants to merge 1 commit into
obsidian-community:mainfrom
BradGroux:docs/improve-landing-page-1134

Conversation

@BradGroux
Copy link
Copy Markdown

Problem

The documentation landing page (Obsidian Kanban Plugin.md) shows only a brief one-line description, two screenshots, and sponsorship links. On mobile, there's no indication that this is a documentation site, and no way to discover the actual docs content without finding the sidebar hamburger menu.

As reported in #1134:

"The site should be like, 'Welcome to the documentation! Hello, I am the documentation and here are some text and links to start your journey of learning about the plugin which I document.'"

Changes

Restructured the landing page to serve as a proper documentation hub:

  • Clear title and description — immediately tells visitors what the plugin does
  • Getting Started — links to installation and board creation guides
  • How Do I... — complete list of all how-to guides with wiki-links
  • Settings — full reference linking to every settings documentation page
  • FAQs — links to known gotchas and limitations
  • Links — GitHub, issues, and roadmap moved to a dedicated section at the bottom
  • Support — sponsorship links preserved at the bottom

All navigation uses Obsidian wiki-links ([[]]) consistent with the existing docs structure, so they work correctly on Obsidian Publish.

Fixes #1134

…bsidian-community#1134)

The documentation landing page previously showed only a brief
description, two screenshots, and links to GitHub. On mobile especially,
visitors had no indication they were on a documentation site or how to
navigate to the actual docs content.

Restructured the landing page to include:
- Clear title and description of what the plugin does
- Getting Started section with links to installation and board creation
- Full 'How Do I' section linking to all how-to guides
- Complete Settings reference with links to every setting page
- FAQs section
- External links (GitHub, issues, roadmap) moved to bottom

Fixes obsidian-community#1134
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation site shows no sign that it is the documentation site on mobile

1 participant