obsidianmd / obsidianmd/obsidian-developer-docs
pre pull request - Create your first plugin doc update
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
The README said to open an issue first.
The docs say to "Restart Obsidian" in steps 4 and 5. There is a reload plugins button in settings that I am guessing did not exist when this was written. I have changes ready to go in a forked repo.
proposed updated text with new image showing the reload plugins button:
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 linked Getting started page and review steps 4 and 5, which currently tell users to restart Obsidian. Update those instructions to reflect the reload plugins button and include the proposed image; the work is done when the page accurately describes the current plugin-reload workflow.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 38/100