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

Documentation should mention how to inject fluent theming #592

Open
dzearing opened this issue Aug 3, 2024 · 1 comment
Open

Documentation should mention how to inject fluent theming #592

dzearing opened this issue Aug 3, 2024 · 1 comment
Assignees
Labels
📃 documentation Improvements or additions to documentation

Comments

@dzearing
Copy link
Member

dzearing commented Aug 3, 2024

I want to get SSR working on a site which uses Fluent controls.

I went to the Griffel doc site and followed the weback extraction instructions. I got extraction working but none of the fluent controls seemed to be styled.

This was because there was no theme rendered. To get that working, I had to follow the instructions here: microsoft/fluentui#29052

I really am not totally sure if Griffel docs should mention Fluent, or if Fluent docs should replicate all the Griffel docs, but it's very tricky for mere mortals to figure everything out without deep communication with the team or really digging into past PRs and issues. I would love a basic "got a webpack app? Here's how you get the extraction working so that Fluent controls render." FWIW everything so far in the docsite is great and got me far enough, just that the theming step was not mentioned.

I think just a note in the docs about Fluent and theming would go pretty far here. We don't need a full on comprehensive walkthrough, just perhaps a mention that if you're working with Fluent controls, go to this other place for more related docs on supporting themes in SSR.

@layershifter
Copy link
Member

@dzearing to be Griffel is a part of Fluent, not vice versa. That's why as you mentioned it should in Fluent docs.

I am going to work on improvements to SSR setup (support for RSC) both for Griffel and Fluent, I will ensure that new docs that explain the proper setup end to end would be in place.

Thx for heads up.

@layershifter layershifter added the 📃 documentation Improvements or additions to documentation label Aug 5, 2024
@layershifter layershifter self-assigned this Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📃 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants