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(web): add v2 components for docs #5975

Merged
merged 10 commits into from
Aug 16, 2024
Merged

feat(web): add v2 components for docs #5975

merged 10 commits into from
Aug 16, 2024

Conversation

davidsoderberg
Copy link
Contributor

@davidsoderberg davidsoderberg commented Jul 4, 2024

No description provided.

@davidsoderberg davidsoderberg requested a review from a team July 4, 2024 05:56
@davidsoderberg davidsoderberg changed the title feat: add v2 components for docs feat(web): add v2 components for docs Jul 4, 2024
@@ -81,6 +97,10 @@ export const Docs = ({ code = '', description = '', title = '', isLoading, child
}

if (Component === null) {
if (isChildDocs) {
return <Text>We could not load this part of the documentation for you. Please try again.</Text>;
Copy link
Contributor

Choose a reason for hiding this comment

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

In what scenario will this happen? And what will change if the user will try again?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If the docs could not be fetched from github for some reason. It could if it is github that is the issue. For me it is more a being nice to the user thing.

Copy link
Contributor

@antonjoel82 antonjoel82 left a comment

Choose a reason for hiding this comment

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

Thanks for the updates, David! Left some feedback for things to help future maintainers

apps/web/src/components/docs/ChildDocs.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/Docs.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/Docs.tsx Outdated Show resolved Hide resolved
<Flex justify="space-between" align="center">
<TitleH1
className={css({
width: '99%',
Copy link
Contributor

Choose a reason for hiding this comment

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

question: Why do we need this?‏

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because otherwise the floating close icon and external link will be hiding part of the title

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, then there's probably a solution that may address it more directly that would be better to aim for

apps/web/src/components/docs/Docs.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/Docs.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/Docs.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/Docs.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/ChildDocs.tsx Show resolved Hide resolved
@antonjoel82 antonjoel82 self-requested a review July 9, 2024 20:43
Copy link
Contributor

@antonjoel82 antonjoel82 left a comment

Choose a reason for hiding this comment

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

Thanks for the updates!

<Flex justify="space-between" align="center">
<TitleH1
className={css({
width: '99%',
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, then there's probably a solution that may address it more directly that would be better to aim for

apps/web/src/components/docs/globals.tsx Outdated Show resolved Hide resolved
apps/web/src/components/docs/docs.const.ts Outdated Show resolved Hide resolved
.cspell.json Outdated Show resolved Hide resolved
Copy link
Contributor

@rifont rifont left a comment

Choose a reason for hiding this comment

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

Awesome work! 🚀

@rifont
Copy link
Contributor

rifont commented Aug 16, 2024

@davidsoderberg can we get this merged?

@rifont rifont merged commit e3e82d8 into next Aug 16, 2024
25 checks passed
@rifont rifont deleted the fix-v2-docs branch August 16, 2024 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants