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

Add contextual links to demos #2649

Merged
merged 15 commits into from
Feb 6, 2024
Merged

Add contextual links to demos #2649

merged 15 commits into from
Feb 6, 2024

Conversation

Strift
Copy link
Contributor

@Strift Strift commented Dec 12, 2023

Pull Request

What does this PR do?

  • Add links to relevant demos on the screenshots
  • Add links to the SaaS demo on those pages: tenant tokens, sorting, tenant tokens, multi-search API
  • Add links to the Ecommerce demo on those pages: faceted search, sorting

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@meili-bot
Copy link
Collaborator

How to see the preview of this PR?

⚠️ Private link, only accessible to Meilisearch employees.

Go to this URL: https://website-git-deploy-preview-mei-16-meili.vercel.app/docs/branch:add-demos

Credentials to access the page are in the company's password manager as "Docs deploy preview".

Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

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

We are unfortunately required to use the official GitHub spelling. It's clumsy, but 🤷

Also, as I mention in my comment, I'm not big on the idea of adding new sections to the reference pages. They have a fairly strict structure so users can find info quickly.

learn/fine_tuning_results/faceted_search.mdx Outdated Show resolved Hide resolved
learn/fine_tuning_results/sorting.mdx Outdated Show resolved Hide resolved
learn/security/tenant_tokens.mdx Outdated Show resolved Hide resolved
reference/api/multi_search.mdx Outdated Show resolved Hide resolved
Strift and others added 4 commits January 15, 2024 18:16
Co-authored-by: gui machiavelli <gui@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
@Strift
Copy link
Contributor Author

Strift commented Jan 15, 2024

Hello,

For simplicity, I approved your changes removing the demo in reference.

However, do you have another page to recommend to include this link? It's the only one I found that focuses on multi-search, and the laravel demo is the only that showcase multi search :(

@guimachiavelli
Copy link
Member

Hmmm…good point. The only other place we mention multi-search is the Meilisearch overview. Perhaps we could add it there for the moment? It's not ideal, but it's one of the most visited docs pages.

In the future I'd like to have a simple multi-search guide which would be the ideal place for a demo link, but I really can't give you anything resembling a timeline right now.

@Strift
Copy link
Contributor Author

Strift commented Jan 22, 2024

I'm happy to merge as-is and consider where to include that link in a future PR.

Feel free to merge whenever possible 🙏

Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

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

Sorry, lost sight of this for the past couple of weeks.

Merging!

@guimachiavelli guimachiavelli merged commit 00675b7 into main Feb 6, 2024
1 check passed
@guimachiavelli guimachiavelli deleted the add-demos branch February 6, 2024 15:48
Strift added a commit that referenced this pull request Feb 23, 2024
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