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

docs(): add markprompt help chat #7837

Merged
merged 4 commits into from
Apr 18, 2023

Conversation

jeffmerrick
Copy link
Contributor

@jeffmerrick jeffmerrick commented Apr 17, 2023

Adds Markprompt help chat bot. It will appear in the lower right of the viewport on all pages.

  • New dependencies for the markprompt component itself and a simple modal package.
  • Adds new environment variable DOCUSAURUS_MARKPROMPT_PROJECT_KEY for the markprompt project key
  • Default Markprompt styling uses Tailwind classes so rather than adding Tailwind just for this, added some basic styling. (It appears there are plans for a future headless version of the component.)

Screen Shot 2023-04-17 at 2 26 07 PM

Screen Shot 2023-04-17 at 2 26 44 PM

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

docs-website/docusaurus.config.js Outdated Show resolved Hide resolved
<>
<div className={clsx(styles.markprompt)}>
<BotIcon />
<Markprompt placeholder="Ask me anything about DataHub!" projectKey={siteConfig.customFields.markpromptProjectKey} />
Copy link
Collaborator

Choose a reason for hiding this comment

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

this part looks a bit cramped
image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made some changes to include the source list be included in scrollable area along with some mobile and dark mode tweaks I missed.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks!

@hsheth2 hsheth2 merged commit 1c03bef into datahub-project:master Apr 18, 2023
yoonhyejin pushed a commit that referenced this pull request Apr 19, 2023
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.

None yet

2 participants