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/docusaurus-theme-search #9063

Merged
merged 3 commits into from
Jun 14, 2023

Conversation

schneegansm
Copy link
Contributor

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

We have built a Docusaurus plugin to easily add LLM-powered search to a docs site, powered by Markprompt.

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

@facebook-github-bot
Copy link
Contributor

Hi @schneegansm!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@netlify
Copy link

netlify bot commented Jun 13, 2023

[V2]

Name Link
🔨 Latest commit b167ef7
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/6489d8a8d6680100087a7fd3
😎 Deploy Preview https://deploy-preview-9063--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Jun 13, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 89 🟢 97 🟢 92 🟢 100 🟠 89 Report
/docs/installation 🟠 79 🟢 100 🟢 92 🟢 100 🟠 89 Report

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 13, 2023
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Jun 14, 2023
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

Thanks 👍 first LLM plugin 🥳

Is there a live Docusaurus sample site with Markprompt that we can check? @michaelfester said there was but couldn't find it.

The example repo is nice but not having a live site available makes it harder to see what it looks like if we have to create a new Docusaurus site and install things locally.

Browsing your repo does not show any screenshot, and the demo tweet is afaik not even a Docusaurus site 😅

So i'd suggest adding screenshots, video and/or live Docusaurus website demo to your repo so that users can more easily project themselves using this new plugin

website/community/2-resources.mdx Outdated Show resolved Hide resolved
@slorber slorber changed the title Add @markprompt/docusaurus-theme-search docs: add @markprompt/docusaurus-theme-search Jun 14, 2023
@slorber slorber merged commit ae1e49d into facebook:main Jun 14, 2023
@michaelfester
Copy link

Thanks 👍 first LLM plugin 🥳

Is there a live Docusaurus sample site with Markprompt that we can check? @michaelfester said there was but couldn't find it.

The example repo is nice but not having a live site available makes it harder to see what it looks like if we have to create a new Docusaurus site and install things locally.

Browsing your repo does not show any screenshot, and the demo tweet is afaik not even a Docusaurus site 😅

So i'd suggest adding screenshots, video and/or live Docusaurus website demo to your repo so that users can more easily project themselves using this new plugin

Great, will do!

This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants