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

[Aksel.nav.no, Button docs] Renamed 'frameworks' example to 'button as link'. #3135

Merged
merged 6 commits into from
Sep 10, 2024

Conversation

KenAJoh
Copy link
Collaborator

@KenAJoh KenAJoh commented Sep 6, 2024

Description

Hopefully allows docreaders to see more of Buttons capabilities.

Copy link

changeset-bot bot commented Sep 6, 2024

⚠️ No Changeset found

Latest commit: 4493554

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@HalvorHaugan
Copy link
Contributor

Would "As link" be even clearer than "Navigation"? Not sure myself, just a thought.

While we're at it, I also have some comments about the content:

  • Does people know what "OverridableComponent" means, or should we modify the desc?
  • Should we use Link as NextLink to make it easier to understand that it comes from Next and not Aksel? (I bet many people skip the imports when reading code)

@KenAJoh
Copy link
Collaborator Author

KenAJoh commented Sep 9, 2024

Would "As link" be even clearer than "Navigation"? Not sure myself, just a thought.

Maybe wiring out "Button as link" would be another alternative 💡

  • Does people know what "OverridableComponent" means, or should we modify the desc?

Good point, think i added href support to desc-texts so i can link to our documentation there 🔗

  • Should we use Link as NextLink to make it easier to understand that it comes from Next and not Aksel? (I bet many people skip the imports when reading code)

Good idea 👍

HalvorHaugan
HalvorHaugan previously approved these changes Sep 9, 2024
Copy link
Contributor

@HalvorHaugan HalvorHaugan left a comment

Choose a reason for hiding this comment

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

Remember to update the PR title ;)

@KenAJoh KenAJoh changed the title [Aksel.nav.no] Renamed 'frameworks' example -> 'navigation' [Aksel.nav.no, Button docs] Renamed 'frameworks' example to 'button as link'. Sep 9, 2024
@HalvorHaugan
Copy link
Contributor

Playroom does not support Nextjs link

You can also consider disabling sandbox for that example.

@KenAJoh KenAJoh merged commit 672fdb9 into main Sep 10, 2024
4 checks passed
@KenAJoh KenAJoh deleted the button-docs-framework branch September 10, 2024 10:42
This pull request was closed.
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.

2 participants