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

[DOC] Improved Search Results #46

Merged
merged 4 commits into from
Jan 3, 2021

Conversation

Smankusors
Copy link
Member

Proposed changes

Here I propose about improving search results. So instead of search result ends with ".html", which IMO not good, I improved it with new format "[category, if any] > [document title]". I also added additional tags (previously it written as "title") that hopefully will produce better search results.

Screenshots (if appropriate) or codepen:

before and after

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist:

  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@Smankusors Smankusors requested a review from a team October 26, 2020 09:17
@DanielRuf DanielRuf added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 26, 2020
Copy link

@nekonenene nekonenene left a comment

Choose a reason for hiding this comment

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

@Smankusors
Great, nice feature!!

  • css-transitions.html
  • floating-action-button.html
  • auto-init.html

The search for the above pages is missing, so it would be better to add them. ✈️ (Though it is a problem of the original source)

@Smankusors
Copy link
Member Author

@Smankusors
Great, nice feature!!

  • css-transitions.html
  • floating-action-button.html
  • auto-init.html

The search for the above pages is missing, so it would be better to add them. ✈️ (Though it is a problem of the original source)

thanks for mentioned it. I thought everything is already covered 😅

docs/js/search.js Outdated Show resolved Hide resolved
Copy link

@nekonenene nekonenene left a comment

Choose a reason for hiding this comment

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

Thanks!

@DanielRuf DanielRuf merged commit 31c6538 into materializecss:v1-dev Jan 3, 2021
@Smankusors Smankusors deleted the improve-search-doc branch September 5, 2021 10:01
@Smankusors Smankusors removed the enhancement New feature or request label Apr 9, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants