Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

Integrated tooltip functionality #685

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Conversation

scott-klaytn
Copy link
Collaborator

Proposed changes

Added tooltip functionality to Klaytn docs to improve user experience by providing contextual help and reducing cognitive load.

  • A React tooltip library installed and integrated into Docusaurus project.
  • Some of React components are swizzled for customization. (path: src/theme/MDXComponents)

Types of changes

Please put an x in the boxes related to your change.

  • Minor Issues and Typos
  • Major Content Contribution
  • Others

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING GUIDELINES
  • I have signed the CLA
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Related issues

Further comments

  • You can see the tooltip examples (e.g. "Klaytn Governace Council", "proposer") mainly on Klaytn Overivew, Why Klaytn pages.
  • Most terms are clickable and lead to the relevant entry on Glossary page on click.
  • If you want to add a tooltip to an unfamiliar term in a markdown file, refer to the following examples:
<LinkWithTooltip tooltip="This is a tooltip without a link.">Hover over me!</LinkWithTooltip>
<LinkWithTooltip to="/path/to/target" tooltip="This is a tooltip with a link.">Hover over me!</LinkWithTooltip>

@scott-klaytn scott-klaytn merged commit 9f16572 into klaytn:main Mar 27, 2024
2 checks passed
@scott-klaytn scott-klaytn deleted the add-tooltip branch March 27, 2024 07:25
@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants