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

Created documentation for SkipToContentLink #2326

Merged
merged 27 commits into from
Nov 12, 2024
Merged

Conversation

smmr-dn
Copy link
Contributor

@smmr-dn smmr-dn commented Nov 4, 2024

Changes

Created documentation for the SkipToContentLink component. Further improvement will be done for this documentation.

Testing

N/A

Docs

N/A

After-PR TODO:

Copy link
Contributor Author

@smmr-dn smmr-dn left a comment

Choose a reason for hiding this comment

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

The examples are currently not working since the page uses the "#" identifier to move focus to its section (e.g. Usage, Props, ...) but not the actual div that contains the main content's id, which causes the page not focusing on the main content of each example. I notice the v2 storybook opens the links in new tab so maybe we can do something similar for this doc? Other than that, I'm not sure how I should handle the examples.

@smmr-dn smmr-dn marked this pull request as ready for review November 5, 2024 16:19
@smmr-dn smmr-dn requested a review from a team as a code owner November 5, 2024 16:19
@smmr-dn smmr-dn requested review from mayank99 and r100-stack and removed request for a team November 5, 2024 16:19
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
Copy link
Member

@r100-stack r100-stack left a comment

Choose a reason for hiding this comment

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

No more comments than the ones already opened.

Copy link
Contributor

@mayank99 mayank99 left a comment

Choose a reason for hiding this comment

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

Pre-approving with some suggestions.

apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/skiptocontentlink.mdx Outdated Show resolved Hide resolved
examples/SkipToContentLink.main.jsx Outdated Show resolved Hide resolved
Copy link
Contributor

@mayank99 mayank99 left a comment

Choose a reason for hiding this comment

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

LGTM

@smmr-dn smmr-dn merged commit 400c14c into main Nov 12, 2024
18 checks passed
@smmr-dn smmr-dn deleted the uyen/skip-content-doc branch November 12, 2024 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants