Skip to content

☂️ Improve Documentation #689

@MarcusNotheis

Description

@MarcusNotheis

This is an umbrella issue for improving our documentation.

When checking a story, the following points should be taken into consideration:

  • Migration from .tsx to .mdx
  • Description for props
  • In case there are imperative methods on the ref (e.g. Dialog - open()) make sure they are described properly
  • Add an overall component description to the source file

Charts

  • BarChart
  • ComposedChart
  • ColumnChart
  • DonutChart
  • LineChart
  • MicroBarChart
  • PieChart
  • RadarChart
  • RadialChart
  • ScatterChart

Components

  • ActionSheet
  • AnalyticalCard
  • AnalyticalTable
  • Bar
  • Breadcrumbs
  • FlexBox
  • FilterBar
  • Form
  • Grid
  • Loader
  • MessageBox
  • ObjectPage
  • ObjectStatus
  • Page
  • Spinner
  • Text
  • Toolbar
  • VariantManagement

Web Components

All Web Components should already have a prop description as this one is generated

  • Avatar
  • Badge
  • BusyIndicator
  • Button
  • Card
  • Carousel
  • CheckBox
  • ComboBox
  • Calendar
  • DatePicker
  • DateTimePicker
  • DurationPicker
  • DateRangePicker
  • Dialog
  • FileUploader
  • FlexibleColumnLayout
  • Icon
  • Input
  • Label
  • Link
  • List
  • MultiComboBox
  • MultiInput
  • MessageStrip
  • NotificationListGroupItem
  • NotificationListItem
  • Popover
  • Panel
  • ProductSwitch
  • ProgressIndicator
  • RadioButton
  • ResponsivePopover
  • RatingIndicator
  • SideNavigation
  • Switch
  • SegmentedButton
  • Select
  • ShellBar
  • TabContainer
  • Token
  • Tokenizer
  • Tree
  • TimePicker
  • Title
  • Toast
  • Table
  • Timeline
  • ToggleButton
  • TextArea
  • UploadCollection

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions