feat: Add Event Type/Interface to Docs

Open
#3,427 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the UI component documentation's Events sections and trace each event to its TypeScript type or interface in the repository. Update the relevant documentation so event type or interface names are shown, and verify that the documented names match the source definitions.

Written by the indexing model from the issue text.

Description

content feature request
Describe Problem

Hi guys,

Love your documentation, its really great. But I'm missing a very important point:
Every UI component has its own "Events" section where the events are described. Most of us are using Ionic with TypeScript so it would be great to know which event type the events are returning (if any).
I always need to look up that information directly in your repo. Would me great to have this type/interface information directly in your docs.

Thanks!

Describe Preferred Solution

At least add the event Type/Interface names in the documentation.

Describe Alternatives

No response

Additional Information

No response

Dominant language
MDX
Stars
621
Forks
3.2k
Avg merge
1d 2h
Merged PRs (30d)
86

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ionic-team/ionic-docs

All issues in ionic-team/ionic-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.