Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for Beta components #19389

Closed
7 of 16 tasks
behowell opened this issue Aug 12, 2021 · 3 comments
Closed
7 of 16 tasks

Update documentation for Beta components #19389

behowell opened this issue Aug 12, 2021 · 3 comments

Comments

@behowell
Copy link
Contributor

behowell commented Aug 12, 2021

This issue tracks that all components included in beta have had their documentation updated to conform to the standards listed here: https://github.com/microsoft/fluentui/blob/master/rfcs/convergence/authoring-stories.md

@PeterDraex
Copy link
Contributor

PeterDraex commented Aug 26, 2021

There are few planned changes to the way we write stories:

  1. Putting each story in its own file will be mandatory. Please use the way described in paragraph 7 for all components.
  2. It's okay to place all .stories.tsx files into a stories folder.
  3. Relative imports will not be supported. For example import { Button } from '../../Button'; will need to be replaced with import { Button } from '@fluentui/react-button';.

These changes are necessary to enable easy integration with CodeSandbox. It’d be great if updated documentation respected these rules already, so we would avoid rewrites.

Pull request with proposed changes: #19827

@layershifter
Copy link
Member

@behowell is it still a thing? Can be this closed?

@layershifter
Copy link
Member

As beta was released and there was also done a ton of work on improving docs 👉 closing this.
We only don't have docs for icons, but it's tracked in the separate issue.

Feel free to reopen if there is need.

Repository owner moved this from Todo to Done in @fluentui/react-components v9.0.0 Nov 30, 2021
@microsoft microsoft locked as resolved and limited conversation to collaborators Dec 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Development

No branches or pull requests

4 participants