obsidianmd / obsidianmd/obsidian-developer-docs

Tidy requirements for plugin metadata

Open Beginner friendly
#242 0 comments 0 reactions 0 assignees View on GitHub

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:

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.