obsidian-plugin/lossless-group_perplexed-plugin
1
0
Fork 0
mirror of https://github.com/lossless-group/perplexed-plugin.git synced 2026-07-22 06:49:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add(reminder): seed Obsidian-API-docs reminder for context-v

Browse source 
Adds a context-v/reminders/ note that points future humans and AI agents
to the canonical Obsidian API source of truth and lists the most common
community plugin review-bot rejection reasons. Same canonical reminder is
being seeded across every plugin in the content-farm ecosystem so the
content-farm splash's rolled-up context-v feed has reminders surfacing
from every plugin once the GitHub Content API loader lands.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
mpstaton 2026-05-04 21:35:31 -05:00
parent be2fad757b
commit 68edd23359
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
context-v/reminders/This-is-an-Obsidian-plugin-Read-Obsidian-API-Docs.md Normal file
View file

@ -0,0 +1,38 @@
---
title: "This Is an Obsidian Plugin — Read the Obsidian API Docs"
purpose: "Reminder for any human or AI working in this codebase: this is an Obsidian plugin. The Obsidian API at https://github.com/obsidianmd/obsidian-api is the source of truth. Consult it before guessing API shapes, and re-read it whenever the community plugin review bot flags something."
status: Authoritative
last_verified: 2026-05-04
applies_to: any plugin in the lossless-group/content-farm ecosystem
authors:
- Michael Staton
augmented_with: Claude Code on Claude Opus 4.7 (1M context)
---
## The one rule
You are working on an Obsidian plugin. **The Obsidian API is the source of truth.**
- Canonical types and method signatures: <https://github.com/obsidianmd/obsidian-api>
- Developer docs: <https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin>
- Sample plugin: <https://github.com/obsidianmd/obsidian-sample-plugin>
Do not invent API shapes. Do not guess. Obsidian runs on Electron with a custom DOM model; browser conventions you reach for from muscle memory often do not apply.
## Common review-bot rejection reasons
The community plugin review bot is automated and uncompromising. The most frequent rejection reasons we (and others) hit:
- **`any` types — banned.** Use the actual types from the `obsidian` package. `eslint-disable` workarounds are themselves rejection reasons.
- **`innerHTML` / `outerHTML` — banned.** Use `createEl`, `setText`, `empty()`, etc.
- **`var` — banned.** `let` / `const` only.
- **Direct DOM manipulation outside the plugin's container.** Don't reach into Obsidian's UI from your plugin's code.
- **`console.log` left in shipped code.** Flagged.
- **Missing or incorrect `manifest.json` fields.** `id`, `name`, `version`, `minAppVersion`, `description`, `author`, and `isDesktopOnly` are mandatory.
- **Mobile compatibility.** Set `isDesktopOnly: true` honestly if you depend on Node APIs, or write a mobile-safe path.
## When in doubt
Read the API. Check the sample plugin. Look at how an existing plugin in this farm solves the same problem — the suite is small enough to grep across via the `content-farm` pseudomonorepo. If still unsure, write a small test in the dev sandbox before committing to the API call.
This file exists because it is *very easy* to write code that compiles and runs locally but gets rejected at submission time. The rule was learned the hard way; do not relearn it.