obsidianmd / obsidianmd/obsidian-developer-docs
Feat: Adding a Description for Each Typescript Class and Function
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
- I've noticed that there are still a lot of classes and functions that don't have any description in the Obsidian API documentation. As a result, sometimes I have to keep tracing the source code to figure it out.
- Is there any chance we can add more descriptions.
- I also noticed that some functions may be obsolete or removed. We can do a history trace for each function. Generate a new version of the API documentation on top of the project. I have a cool idea.
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 by reviewing the existing Obsidian API documentation and identifying classes and functions without descriptions. Compare those entries with the project source and trace their history to determine whether they remain current. Done would require a newly generated API documentation version with descriptions and obsolete or removed entries addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100