Skip to content

Conversation

@svdimitr
Copy link
Contributor

@svdimitr svdimitr commented Mar 15, 2021

New Component Checklist (delete for other types of PRs)

  • - Overview article

    • General information on the purpose of the component.
    • Instruction on how to add the component to a razor component.
    • Basic configuration of the component - code snippet with a scenario that is both basic, and meaningful.
    • Provide information on the component's reference.
    • List the available features for the component and/or provide links (slugs) for the articles that explain them in details. For simpler components listing parameters might be enough, for more complex ones sections with a sentence or two that links corresponding articles might be more suitable.
    • Maybe some Example(s) - very common scenarios, notes, typical use case, etc. Not mandatory, depends on the component.
  • - Data binding article - applicable if data can be provided to the component. My be one article or a folder with several articles (examples - DropDownList and TreeView)

  • - Feature/component specific articles - those articles explain the component specific features, which do not suit in any of the before-mentioned articles. Examples of such articles are the Navigator for the Stock Chart, the Indeterminate state for the CheckBox and others.

  • - Selection article - applicable if the component exposes items selection. May be a folder.
    [ ] - Single item selection
    [ ] - Multiple item selection

  • - Templates - applicable if additional customization is allowed with Templates. Usually a folder, see the grid

  • - Events article - applicable if the component expose events.
    Examples of such events could be:

  • OnClick
  • OnChange
  • ValueChanged
  • SelectedItemsChanged
  • OnRead
  • etc.
  • Update Input Validation, Globalization, Keyboard Navigation, Accessibility Compliance articles as applicable.

  • Link from the Overview components list

@svdimitr svdimitr requested a review from marin-bratanov March 15, 2021 16:30
@svdimitr svdimitr self-assigned this Mar 15, 2021
Copy link
Contributor

@marin-bratanov marin-bratanov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like a lot of comments, but nothing is really major, just minor tweaks that can take the whole docs to a new level. I like the structure and how you can find the main elements of the component at the root level of the docs, and so many details and examples for each.
While I'd like to see those comments acted on, I am approving this PR.
EDIT: you could also mention the gauges (may be as a single bullet "Gauges") in the KBD nav article just like we do for the chart so it is clear they can't have kbd navigation.

_config.yml Outdated
"Radar Column Charts": "chart-types-radarcolumn"
"Radar Line Charts": "chart-types-radarline"
"Stock Chart": "stockchart-overview"
"Gauge - Linear": "linear-gauge-overview"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider calling these "Linear Gauge", "Circular Gauge" and so on here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@svdimitr svdimitr merged commit a18cb9d into master Mar 19, 2021
@svdimitr svdimitr deleted the docs-linear-gauge branch March 19, 2021 13:32
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

Successfully merging this pull request may close these issues.

4 participants