obsidianmd / obsidianmd/obsidian-developer-docs
Include the version number for the version of the API docs shown
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
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.
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 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.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100