luckyframework / luckyframework/website

Validations don't show up in Algolia search

Open
#1,247 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Crystal
Stars
39
Forks
62
PR merge metrics
No merged PRs in 30d

Description

I ran into this a few times already; validations don't show up in the search results. So if you search for `uniqueness`, `inclusion` or even the full `validate_uniqueness_of` for example, there's no link to that page.

I'm not sure what needs to happen to include them, but I'm open to creating a PR if anyone can give me some pointers.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the website's validation pages are indexed in Algolia and compare them with pages that already appear in search results. Done means searches for "uniqueness", "inclusion", and "validate_uniqueness_of" link to the relevant validation documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
crystal
Domain
documentation, search
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.