microsoft / fluentui Public

Component documentation should include:

• Short description mentioning the use case for a component
• Set of best practices
• Set of examples showing base principles. For each example, include: o Name and short description o Possibility to open, edit and execute modified example code o Possibility to export examples to CodeSandbox o Possibility to change theme of components (one switch for the whole documentation) o Possibility to copy a direct link o Possibility to report a bug (GitHub issue) related to a component or example
• List of known issues for the component, imported from GitHub
• List of related or child components (for example Accordion has AccordionTitle and AccordionPanel)
• List of properties of the component with name, default value, and description
• Names of packages to which the component belongs, so people would know what to install/import

The production version of documentation must offer an option to select version of the UI library for which documentation will be displayed.

It’s also necessary to:

• Create a documentation page informing developers how to write Storybook stories in such a way that all mentioned requirements would be met.
• Ensure there is a way to create a story, which will be used for testing but will not be visible in documentation.
• Implement scaffolding of new components using NX.
• Propose a process and create a build system for partners to add their components to the documentation.