microsoft / fluentui-contrib

Monorepo for contributor extension packages to Fluent UI
MIT License
29 stars 31 forks source link

Proposal: Introduce react-fluentui-examples project #189

Open george-cz opened 3 months ago

george-cz commented 3 months ago

Motivation

Historically, in the effort of supporting our partners, we've built a lot of examples in Stackblitz displaying how to use our components in a particular use case. These use cases don't usually (ever?) make it back to the original docsite, even though others could potentially benefit from them too. The reasons for this are multiple:

The problem with the current approach is that these carefully crafted examples end in up /dev/null eventually because we forget about them, or don't know about their existence in the first place. Having one place where we could store these, link to them and let the user quickly run them and play with them would be benefitial.

Other attempts

The Fluent UI v0 already has a concept of this, they call it Prototypes. This means that the idea behind this concept has been validated in the past, has proven useful and we should strive to provide a similar solution for our V9 docs.

How this works

The main ideas behind this PR are:

Visit the project here

Other considerations

Footnote

Before this gets merged, all of the links should be updated to target the main branch. Right now for the sake of validating the PR and the usage, it points to this PR branch.

ling1726 commented 3 months ago

I think we should consider a way to get these examples served by the official docsite. It would be good to have a single source of truth here. One of the big issues with v0 prototypes was that they were not discoverable