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

feat: implement docsite for contrib packages #244

Merged
merged 14 commits into from
Oct 22, 2024

Conversation

dmytrokirpa
Copy link
Contributor

@dmytrokirpa dmytrokirpa commented Oct 11, 2024

To enhance the visibility of contrib packages, we've decided to create a documentation site that aggregates documentation for all packages in this repository, similar to what we do for the Fluent UI core repository. This will be integrated into public-docsite-v9 using the Storybook composition feature.

What's New:

  • Added a new docsite application powered by storybook.
  • Selectively adopted Storybook styling and DocsPage components from the core to ensure a consistent user experience with public-docsite-v9, will be replaced with imports from a new package once it's available (planned for Q3, cc @Hotell).
  • Implemented a shared Storybook configuration in /.storybook.
  • This shared configuration is now used across both apps and packages.
  • Updated the titles and added basic descriptions to existing package stories, drawing from the package's README.md.

Demo:

Screen.Recording.2024-10-11.at.16.29.54.mov

Related Issues:
Partially addresses issue #175.

@dmytrokirpa dmytrokirpa self-assigned this Oct 11, 2024
@dmytrokirpa dmytrokirpa added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Oct 11, 2024
@@ -0,0 +1,159 @@
import * as React from 'react';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This component was copied over from https://github.com/microsoft/fluentui/blob/master/apps/public-docsite-v9/src/DocsComponents/FluentDocsPage.stories.tsx and will be removed once original component will be published as a part of a new package.

@@ -0,0 +1,142 @@
import * as React from 'react';
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This component was copied over from https://github.com/microsoft/fluentui/blob/master/apps/public-docsite-v9/src/DocsComponents/Toc.stories.tsx and will be removed once original component will be published as a part of a new package.

.storybook/docs-root.css Outdated Show resolved Hide resolved
@dmytrokirpa dmytrokirpa marked this pull request as ready for review October 11, 2024 16:15
Copy link
Contributor

@Jacqueline-ms Jacqueline-ms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Azure theme looks good. Thanks for doing this!

Copy link
Contributor

@mainframev mainframev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work on this! a few tiny things to improve 🚀

apps/docsite/.storybook/tsconfig.json Show resolved Hide resolved
packages/houdini-utils/README.md Show resolved Hide resolved
apps/docsite/project.json Show resolved Hide resolved
@dmytrokirpa dmytrokirpa requested a review from a team October 15, 2024 12:12
Copy link
Contributor

@Hotell Hotell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

.github/CODEOWNERS Outdated Show resolved Hide resolved
@Hotell
Copy link
Contributor

Hotell commented Oct 22, 2024

admin merging

  • pipeline passes
  • got majority of approvals from owners

@Hotell Hotell merged commit 5f2bc3a into microsoft:main Oct 22, 2024
3 checks passed
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

Successfully merging this pull request may close these issues.

5 participants