Skip to content

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

@bragaru-i

Description

@bragaru-i

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions