Welcome to RSS Dashboard's documentation. Find guides, workflows, references, and answers here.
| Folder | What's in it |
|---|---|
user/ |
Guides for people using the plugin |
development/ |
How the plugin is built, tested, designed, and released |
adr/ |
Architecture decision records: why the code is shaped the way it is |
plans/ |
Active feature plans and the public roadmap |
releases/ |
Release notes, announcements, and their templates |
agents/ |
Conventions for AI coding agents working in this repo |
archive/ |
Finished plans and past investigations, kept for history |
SECURITY.md covers privacy, security, and how to verify a release.
New to RSS Dashboard? Start here to get up and running in minutes.
- Getting Started Guide — Add your first feed, discover content, read articles, organize, and save what matters. A complete first-run workflow.
- Installation Methods — Community Plugins (standard), BRAT (beta testing), or manual installation for advanced users.
Master the everyday tasks that make RSS Dashboard powerful.
- Tags Primer — Organize feeds and articles with automatic and manual tags. Learn precedence, backfill strategies, and filter modes.
- Keyboard Shortcuts — Quick reference for all available shortcuts. Press
?in the app to see the full list. - Syncing Guide — Set up RSS Dashboard on multiple devices with Obsidian Sync or other sync solutions, including essential setup order and naming rules.
- Import Starred Articles — Migrate a Google Reader-compatible
starred.jsonexport (Inoreader, FreshRSS): what gets imported, the Options toggles, and how full-content fetching works.
Detailed guides for specific features and use cases.
- Storage & Vault Shards Guide — Understand storage modes (legacy, Shard v1, Shard v2), how data is organized, and how to migrate between modes.
- One-Click Subscribe URI — Add feeds directly from browser extensions and external apps using Obsidian URI protocol.
Your data, your control.
- Security & Privacy — How your data is stored and transmitted, what information we collect (none), and YouTube privacy details. Complete transparency.
Something not working? Find answers here.
- Troubleshooting & FAQ — Solutions for common issues: feed not loading, YouTube problems, audio playback, sync issues, and how to get help.
Want to contribute or understand how the plugin works internally?
- Contributing Guide — How to set up development, run tests, follow branching strategy, and open a pull request. Before you start, read the compliance declarations.
- Development Docs — Internal architecture, data flows, design specifications, testing guides, and release workflow. For plugin developers and maintainers.
- Plugin Scorecard — Plugin audit and compliance status (for developers and auditors).
- Release Notes & Changelog — What's new in each version and the complete history of changes.
- Latest Release — See what's new in the current version.
- Version History — Release notes for all previous versions.
- 💬 Discord Community — Join the community for discussions, questions, and real-time help.
- 🐛 GitHub Issues — Report bugs or request features.
- 📋 Public Roadmap — See what's being planned and what we're exploring.
| Need | Link |
|---|---|
| First time? | Getting Started |
| Install help | Installation Methods |
| Tag questions | Tags Primer |
| Sync issues | Syncing Guide |
| Stuck? | Troubleshooting |
| Want to help? | Contributing |
| Feedback? | Discord or GitHub Issues |