About explanation for `sourcePath`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation
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.
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!
- 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
- 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.
More from obsidianmd/obsidian-developer-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
obsidianmd/obsidian-developer-docs#265 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
obsidianmd/obsidian-developer-docs#262 · 1 comment ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
obsidianmd/obsidian-developer-docs#252 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
obsidianmd/obsidian-developer-docs#242 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in obsidianmd/obsidian-developer-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
uoftblueprint/canada-basketball#67 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 61/100
Fei2411/DeepSeek-Bot#456 ·
Maintainers usually reply within 1 day
-
área:app área:produto sem-fase tipo:decisão
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
Varanda-org/varanda#91 ·
-
0️⃣ phase/new
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
auth0/express-openid-connect#901 ·
Maintainers usually reply within 1 day