obsidianmd / obsidianmd/obsidian-sample-plugin
Feature request - TSDoc integration
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4.5k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
As someone who was the direct target audience for this plugin (i.e. some programming sans TypeScript/JavaScript experience and someone who just needed additional functionality not found in existing plugins) and who has had to look through the source code of other poorly (or un) documented plugins to figure out what I needed, I think it would be immensely helpful to encourage plugin developers to use TSDoc by implementing the boilerplate code right here in the official template plugin.
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 sample plugin's TypeScript template and build configuration to identify where TSDoc boilerplate would belong. Confirm the intended integration and documentation expectations, then verify that the template supports the requested TSDoc setup without disrupting its existing plugin workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100