Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documentation with typedoc and display it by category tag #109

Open
2 tasks
bragaru-i opened this issue Nov 24, 2022 · 0 comments
Open
2 tasks

Create documentation with typedoc and display it by category tag #109

bragaru-i opened this issue Nov 24, 2022 · 0 comments

Comments

@bragaru-i
Copy link
Contributor

bragaru-i commented Nov 24, 2022

Mentions

Here are docs module page: https://collaborne.github.io/media-player/docs/variables/HighlightsContext-1.html
MediaPlayer's functions, React Components, store is splitted into this categories with help of the tags:

  • React Component
  • UI Controls
  • Player
  • MediaStore
  • Custom Icons
  • React Context
  • ContextProvider
  • hooks
  • Events

The way that typedoc builds interfaces can be hardly interpreted by users(too much unused info).
Ex: they split into Types, Interfaces, Functions, Classes and so on and you need to spend time for understanding this.

Tasks

  • modify navigation (docs)
    image

Example of expected behaviour:

React Component
  - MediaPlayer
  - CorePlayer
  - DraggablePopover
hooks
  - usePlayerContext
  - useDelayedState 

  • modify module page (display it by category tags, not by type)
    image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant