Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 1.88 KB

README.md

File metadata and controls

70 lines (50 loc) · 1.88 KB

Obsidian Documentation Corpus

A data-only documentation corpus for Obsidian. Use with the hiivmind-corpus plugin for navigation and maintenance.

What is This?

This repository contains:

  • Indexed documentation - Structured index of Obsidian docs with summaries and cross-references
  • Source tracking - Configuration tracking upstream documentation commits
  • Keywords - Routing keywords for automatic corpus selection

This is NOT a Claude Code plugin. All operations (navigation, building, refreshing) are provided by the hiivmind-corpus plugin.

Quick Start

1. Install the hiivmind-corpus plugin

# In Claude Code
/plugin install hiivmind/hiivmind-corpus

2. Register this corpus

# Register from GitHub
/hiivmind-corpus register github:hiivmind/hiivmind-corpus-obsidian

3. Start asking questions

How do I use Obsidian plugins?
What are Obsidian canvas files?
How does Obsidian sync work?

File Structure

hiivmind-corpus-obsidian/
├── config.yaml          # Source definitions, keywords, tracking
├── index.md             # Main documentation index
├── index-*.md           # Sub-indexes (for large corpora)
├── uploads/             # Local document uploads
├── .source/             # Cloned docs (gitignored)
├── .cache/              # Web cache (gitignored)
└── README.md

Maintenance

Use hiivmind-corpus skills to maintain this corpus:

Command Purpose
/hiivmind-corpus refresh obsidian Update from upstream changes
/hiivmind-corpus enhance obsidian <topic> Add depth to a topic
/hiivmind-corpus build obsidian Full rebuild
/hiivmind-corpus add-source obsidian <url> Add new source

Requirements

  • hiivmind-corpus plugin (provides all operations)
  • Git (for source management)

License

MIT

hiivmind-corpus-obsidian