daledesilva_obsidian_project-browser/docs

Project Browser documentation

This folder contains documentation for the Project Browser Obsidian plugin.

If you’re new to the codebase or the plugin’s mental model, start with Overview.

Start here

• Overview: what the plugin is, the three main surfaces, and the end-to-end flow.

Core concepts

• Card Browser and navigation: the “always in a folder” browsing model, sections, navigation, and search.
• States and sections: visible vs hidden states, No status, and how states drive grouping.

Features

• Projects: folders that behave like cards, and how project status works.
• Project Pages FAB: the in-editor floating action button for jumping between project pages.
• File type visibility: control what file types appear in the Card Browser and in the pages menu.
• Settings: access/behaviour and display settings that change how the plugin feels.

Contributing / maintenance

• Testing: how to run unit and E2E tests, and how they’re structured.
• Known issues and attempted fixes: limitations and past investigations (useful when debugging).

Quick paths by task

• Understand the product: Overview → Card Browser and navigation → States and sections
• Configure what you see: Settings → File type visibility
• Understand “projects”: Projects → Project Pages FAB