Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Inline documentation for SDK #92

Open
JakeLo123 opened this issue Feb 28, 2024 · 0 comments
Open

Inline documentation for SDK #92

JakeLo123 opened this issue Feb 28, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@JakeLo123
Copy link
Collaborator

Inline documentation for SDK

Problem

There is no inline documentation for components and methods provided by the SDK

Solution

Use JSDoc to include inline docs so that developers get useful descriptions in tooltips, like the screenshot below (pulled in from our Angular SDK).

image

Additional context

We can align requirements/documentation across the react/angular/vue SDKs using our tech spec -- cc: @david-chalk

Community guidelines

All issues filed in this repository must abide by the FusionAuth community guidelines.

How to vote

Please give us a thumbs up or thumbs down as a reaction to help us prioritize this feature. Feel free to comment if you have a particular need or comment on how this feature should work.

@JakeLo123 JakeLo123 added the enhancement New feature or request label Feb 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant