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

Improve/replace the documentation search engine #15

Open
engram-design opened this issue Mar 10, 2021 · 2 comments
Open

Improve/replace the documentation search engine #15

engram-design opened this issue Mar 10, 2021 · 2 comments
Labels
Documentation Improvements or additions to documentation Feature Request New feature or request

Comments

@engram-design
Copy link

I managed to figure it out, but the docs search didn't bring anything up for directions.

image

{# Old #}
{% set directionsUrl = entry.addressField.directionsUrl(entry.title) %}

{# New #}
{% set directionsUrl = entry.addressField.linkToDirections({ title: entry.title }) %}
@lindseydiloreto
Copy link
Collaborator

Good catch. Looks like Vuepress doesn't index code snippets. I'll add the word "directions" to the description.

Thanks for the heads up! 👍

@lindseydiloreto lindseydiloreto added the Documentation Improvements or additions to documentation label Mar 11, 2021
@lindseydiloreto
Copy link
Collaborator

So not only does Vuepress not index code snippets, apparently it doesn't index anything that isn't an <h*> level header.

article@2x

Which makes more sense, because I was already able to find the word "directions" in an existing paragraph...

directions@2x

I'm going to do a little more research to figure out if there's a better search mechanism for the Vuepress docs.

Thanks for bringing this to my attention!

@lindseydiloreto lindseydiloreto added the Feature Request New feature or request label Mar 25, 2021
@lindseydiloreto lindseydiloreto changed the title Migration docs for directionsUrl Improve/replace the documentation search engine Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Feature Request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants