Skip to content

Docs: add Boost Rules documentation#19

Open
novavolcanic wants to merge 1 commit intomainfrom
docs/add-boost-rules
Open

Docs: add Boost Rules documentation#19
novavolcanic wants to merge 1 commit intomainfrom
docs/add-boost-rules

Conversation

@novavolcanic
Copy link
Copy Markdown
Contributor

Closes #12

What changed

  • Added a Boost rules section to docs/administration/projects.md (after Search filters), documenting the BoostRule model fields: pattern (regex matched against full URLs), boost_score (additive float), and tie-breaking behavior (longest match wins).
  • Added a cross-reference paragraph in docs/customization/search.mdx under "Boost search results" pointing to the dashboard boost rules as an alternative to per-page meta tags.

Source of truth

  • biel/apps/projects/models.py:197–217BoostRule model (active, pattern, boost_score, position, project)
  • biel/apps/projects/forms.py:430–460 — form exposes pattern and boost_score only
  • biel/apps/projects/views/views.py:339–340 — gated behind boost.enabled team permission
  • biel/apps/projects/parsers/url_parser.py:1619–1638 — longest-match wins; returns 0.0 if no match
  • biel/apps/projects/parsers/url_parser.py:1421 — rule score adds to page-level biel:boost_score

Verification

  • Code examples match actual API/props
  • Internal links verified
  • Follows Google developer documentation style guide

Add a "Boost rules" section to projects.md explaining URL pattern-based
search ranking rules: pattern syntax, boost score behavior, specificity
tie-breaking, and additive combination with page-level meta tags.

Add a cross-reference in search.mdx pointing to the dashboard boost
rules as an alternative to per-page biel:boost_score meta tags.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 10, 2026

Warning

Rate limit exceeded

@novavolcanic has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 28 minutes and 43 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 28 minutes and 43 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 15e3eeab-644f-4d3b-81f2-9dce3a447a0f

📥 Commits

Reviewing files that changed from the base of the PR and between 39a5251 and fe5a7b7.

📒 Files selected for processing (2)
  • docs/administration/projects.md
  • docs/customization/search.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-boost-rules

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Docs: Missing documentation for Boost Rules project setting

1 participant