Platform: Windows 11 22H2 or later. This is a Widget Board provider and has no macOS/Linux support.
Audience guide: every doc under this tree declares its intended audience in a one-line framing at the top. Read the docs targeted at your role first.
This directory holds everything that didn't fit in the root README.md — the audience-split user guide, the contributor handbook, and the onboarding material for AI coding agents working on the repo.
| Read | For |
|---|---|
users/getting-started.md |
Install, first-run, pin the widget. |
users/widgets/quick-note.md |
The main Quick Note widget — every field, every size. |
users/widgets/recent-notes.md |
The Recent Notes widget — how it refreshes, how to open a note. |
users/widgets/plugin-runner.md |
The Plugin Runner widget — one-tap Obsidian commands. |
users/tray-companion.md |
Optional tray app for keyboard-first capture. |
users/troubleshooting.md |
Copy-paste fixes for common issues. |
| Read | For |
|---|---|
contributing/development.md |
Clone, build, test, sign, install locally. |
contributing/architecture.md |
The COM server, three widget definitions, state flow. |
contributing/adaptive-cards.md |
The Adaptive Cards 1.5 contract + card-input-id table. |
contributing/cli-surface.md |
Every obsidian CLI verb used, with verified stdout shape. |
contributing/testing.md |
Test projects, fakes, how to run one. |
contributing/release.md |
Version bump, MSIX publish, winget pipeline. |
contributing/security.md |
Threat model and findings status. |
| Read | For |
|---|---|
agents/README.md |
1-page onboarding, reading order, entry-point table. |
agents/conventions.md |
The invariants and sharp edges that must not be broken. |
agents/commands.md |
Copy-paste commands for build / test / deploy. |
../.github/copilot-instructions.md |
The authoritative project brief for Copilot. |
| Read | For |
|---|---|
../SECURITY.md |
Vulnerability reporting policy, scope, known considerations. |
contributing/security.md |
Threat model and per-file trust boundaries. |
../CHANGELOG.md |
Release history and any security-related notes per version. |
| File | What it is |
|---|---|
../README.md |
The elevator-pitch landing page — links back here. |
../CHANGELOG.md |
Keep a Changelog format, per-release. |
../SECURITY.md |
How to report vulnerabilities. |
../LICENSE |
MIT. |
../.github/copilot-instructions.md |
Canonical brief for Copilot and other AI agents. Dense but load-bearing. |
- Each doc begins with a 1-sentence audience statement.
- Paths are relative to the doc's own location (so links work both on GitHub and in local editors).
- File references inside prose use
backtickswith the repo-relative path. Clickable links are used when we expect readers to actually follow them. - If a doc disagrees with the code, the code wins — please open an issue.