Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Include the version number for the version of the API docs shown

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the Home page of https://docs.obsidian.md and compare the displayed API documentation with the source at https://github.com/obsidianmd/obsidian-api. Done means the displayed API version is clear and the API repository has a direct link, while helping readers identify when the docs are out of date.

Written by the indexing model from the issue text.

Description

Thank you for this helpful resource!

I think it would be really helpful to show what version of the API is being displayed on https://docs.obsidian.md. Perhaps on the Home page. In addition, I think it would be really helpful to provide a direct link to the API repo in case there is drift.

While working on some plugin PRs based on the recent v1.4.0 API updates, I ran into an issue where I was really confused about why some of the new functionality I was seeing in the 1.4.5 Desktop app wasn't reflected in the TypescriptAPI section of https://docs.obsidian.md. It took me awhile to realize that this repo is out of date from https://github.com/obsidianmd/obsidian-api.

Dominant language
JavaScript
Stars
530
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.