Skip to content

Docs: add Boost Rules documentation #19

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.

Sign up for GitHub

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

Open
novavolcanic wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Docs: add Boost Rules documentation #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/administration/projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,22 @@ Configure filters that allow users to narrow search results by category in the s

Filters appear in the search widget only when `hide-filters` is set to `false` on the widget and the user has started typing a query. For more details, see [Search filters](../customization/search-filters.md).

### Boost rules

Boost rules let you assign search ranking adjustments to groups of pages based on URL patterns, without modifying individual pages.

:::note
Boost rules are available on select plans. Contact support to enable this feature.
:::

Each rule requires:

- **Pattern**: A case-insensitive regular expression matched against full page URLs. For example, `/api/.*` matches all pages under `/api/`.
- **Boost score**: A number that adjusts the page's search ranking. Positive values (for example, `0.5`) increase ranking; negative values (for example, `-0.5`) decrease it.

When multiple rules match a URL, the most specific rule (longest pattern) applies. Rule boost scores combine additively with any page-level `biel:boost_score` meta tag.

For details on boost scoring, see [Boost search results](../customization/search.mdx#boost-search-results).

### LLM settings

Expand Down
2 changes: 2 additions & 0 deletions docs/customization/search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ Add the following meta tag to the `<head>` of the page:

For Docusaurus, Sphinx, and other documentation systems, see [Metadata by platform](#metadata-by-platform).

You can also configure boost rules in **Settings > Boost rules** in the [Biel.ai dashboard](https://app.biel.ai) to apply boost scores to URL patterns without modifying page HTML. Rule scores combine additively with any page-level `biel:boost_score` meta tag. For details, see [Boost rules](../administration/projects.md#boost-rules).

### Metadata by platform


Expand Down