Skip to content
This repository was archived by the owner on Nov 17, 2022. It is now read-only.
This repository was archived by the owner on Nov 17, 2022. It is now read-only.

docs(api-reference): Improve API Discovery #1793

Open
@mudlabs

Description

@mudlabs

Is your feature request related to a problem? Please describe.

When trying to learn more about a given API in the docs it can be difficult to locate the component specific properties and methods; as they are mixed with all its inherited ones.

Describe the solution you'd like

Instead of having the component properties and methods mixed in with the sea of inherited properties and methods, I propose a separation within the Index.

Describe alternatives you've considered

  • Doing a ⌘F (find in page), but that's not very useful if you don't already know what you're looking for.
  • Scrolling all the way to the bottom of the page to workout what the little icons mean. And then trying to spot the ones you want (ain't no body got time for that). And something new devs could easily miss.

Additional context

The Current Index Structure

Index
Constructors
The constructor(s).
Properties
All properties (including inherited etc...), in alphabetical order.
Methods
All methods (including inherited etc...), in alphabetical order.

Proposed Index Structure

Index
Constructors
The constructor(s).
Properties
The specific component properties.
Methods
The specific component methods.
Inherited Properties
The inherited properties.
Inherited Methods
The inherited methods.

Additional Proposal

  • For accessibility and to improve the learning curve (RE what the icons mean), all links should use the title attribute. The title value could follow something like, [Inherited] <property-name>.
  • The Legend section could be moved to the top of the page. Maybe a collapsible component.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions