pre pull request - Create your first plugin doc update

Open
  • Is something wrong?
#164 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

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.

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.

current page

proposed updated text with new image showing the reload plugins button:

Screenshot 2024-12-17 at 10 59 42
Dominant language
JavaScript
Stars
532
Forks
174
Avg merge
3d 3h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from obsidianmd/obsidian-developer-docs

All issues in obsidianmd/obsidian-developer-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.