obsidianmd / obsidianmd/obsidian-developer-docs
Tidy requirements for plugin metadata
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the requirements for plugin IDs lack some information, and are scattered:
-
The requirement for plugin ID is described in:
Manifest - Developer DocumentationAnd the requirements for the plugin description is documented in:
Submission requirements for plugins - Developer Documentation -
A plugin ID "must only contain lowercase ASCII letters and hyphens" according to the "risk" message in the new Obsidian Community site's scorecards, e.g. Orgmode (CM6) - Obsidian Plugin. That is not documented.
Additionally, it is impossible to change a plugin ID after the first submission without the help of Obsidian team.
The following modification would be great.
- Gather requirements into the "Submission requirements for plugins" page.
- Document plugin ID requirements about allowed characters in the "Submission requirements for plugins" page.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Submission requirements for plugins page and compare it with the linked Manifest - Developer Documentation page and the example Community scorecard. Consolidate the plugin ID and description requirements there, add the documented character restriction for plugin IDs, and confirm that the resulting page contains all requirements requested by the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 74/100