obsidianmd / obsidianmd/obsidian-developer-docs
Add explanatory text to ButtonComponent/setCta docs
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
Please could some explanatory docs be added to the setCta page...
I had to ask, and people are still asking:
https://discord.com/channels/686053708261228577/840286264964022302/1330320932086091816
https://docs.obsidian.md/Reference/TypeScript+API/ButtonComponent/setCta
Things to consider mentioning:
- It is an abbreviation for "Call to Action"
- It changes how the button is styled, to make it stand out.
- Use it sparingly, to make the button stand out from others nearby....
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
Open the ButtonComponent/setCta documentation page linked in the issue and review its current explanation. Add the requested meaning of “CTA,” styling behavior, and guidance to use it sparingly; done means the page clearly covers these points.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100