sveltejs / sveltejs/svelte.dev
indicate what type of thing a thing is
Nobody has claimed this yet.
- Dominant language
- Svelte
- Stars
- 330
- Forks
- 278
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
it's super weird to have a heading just called 'Action' here, without anything to indicate that it's an interface that you can import from svelte/action: https://svelte-omnisite.vercel.app/docs/svelte/svelte-action
Might be worth experimenting with changing the order as well, so that the prose goes below the illustrative code block
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 linked svelte/action documentation page and inspect the section headed “Action”; compare its heading with the import path and illustrative code block. Update the documentation so the heading identifies the item as an importable interface and evaluate placing prose below the code block. Done means the section clearly indicates what “Action” is and the layout reads correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100