obsidianmd / obsidianmd/obsidian-developer-docs
About explanation for `sourcePath`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
The sourcePath:string parameter appears in several places in the API, but is sometimes not explained at all. Even when it is explained, the explanation varies from place to place and was not always easy to understand when I started writing plugins. Also, I have seen some plugins using sourcePath incorrectly.
So far, the clearest explanation that I could find is the one given in FileManager.generateMarkdownLink:
https://docs.obsidian.md/Reference/TypeScript+API/FileManager/generateMarkdownLink
where the link is stored in, used to compute relative links.
Hopefully this explanation will be adopted everywhere. Thank you!
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
Search the TypeScript API documentation for every sourcePath:string parameter, then compare those entries with the explanation in FileManager.generateMarkdownLink. Update the explanations so they consistently describe how sourcePath is used for relative links and clarify its correct plugin usage; done means all occurrences are covered and understandable.
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
- 35/100