Skip to content

Conversation

svdimitr
Copy link
Contributor

No description provided.

@svdimitr svdimitr self-assigned this Aug 25, 2022
@svdimitr svdimitr requested review from a team August 25, 2022 13:32
@dimodi
Copy link
Contributor

dimodi commented Aug 30, 2022

  • Use feature sections and headings, according to Docs Overview Template. Try to add the component name only in 3 specific sections - "Creating ...", "... Parameters" and "... Reference and Methods" (GridLayout is an example of the opposite). The Parameters section should come after all feature sections and before Reference and Methods.
  • Use the common template instead of a <style> tag for the table layout styles.
  • Provide parameter information in a "Parameters" section. If you need to group parameters in several tables, use H3 headings under the main "Parameters" section (e.g. in Circular Gauge, MaskedTextBox). See https://docs.telerik.com/blazor-ui/components/filemanager/overview#filemanager-parameters
  • The reference example does not need fully qualified namespaces. We require the base namespaces in Imports anyway. If a component has a dedicated page with method usage (e.g. Notification), the Reference and Methods snippet can be short, non-runnable and link to the other article for the details.
  • Follow the code style guide.
  • Provide Next Steps with links in all Overview articles. Order them in the most meaningful way for the getting started experience for the given component. Use "See Also" for KBs, online demos and API reference.
  • Remove all screenshots, except the animated ones and those that include additional overlaying notes (e.g. like in https://docs.telerik.com/blazor-ui/components/scheduler/views/multiday#slots ).
@svdimitr svdimitr requested a review from dimodi September 1, 2022 13:39
svdimitr and others added 27 commits September 7, 2022 15:20
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@svdimitr svdimitr force-pushed the svd-overview-revamps branch from 3c25774 to 0a04d44 Compare September 7, 2022 12:23
@svdimitr svdimitr merged commit 1a634a1 into master Sep 7, 2022
@github-actions github-actions bot deleted the svd-overview-revamps branch September 7, 2022 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants