Skip to content

Commit ee07172

Browse files
authored
chore: add note to README about search (#519)
1 parent 853a020 commit ee07172

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ This repository contains the source code for [Flarum's docs site](https://docs.f
44

55
In order to avoid conflicts and corruption during translation synchronization, we only currently accept content contributions in English, and translations are only accepted through [crowdin](https://crowdin.com/project/flarum-docs). We really appreciate all contributions, and these measures help ensure that documentation is up to date and avoids breaking unexpectedly. See [our docs](https://docs.flarum.org/contributing-docs-translations) for more information.
66

7+
## Search
8+
9+
Search is powered by [Algolia](https://www.algolia.com/) via Docusaurus's built-in Algolia theme. Algolia uses an external web crawler that periodically indexes the **deployed site** at `https://docs.flarum.org` — it does not index local builds.
10+
11+
This means:
12+
- New or updated pages will **not appear in search** until they are deployed to production and the Algolia crawler has re-indexed the site.
13+
- Pages must be listed in `sidebars.js` to be included in the built site and therefore indexed.
14+
- Search results are filtered by doc version (`contextualSearch: true`), so `2.x` pages won't appear when searching from the `1.x` docs and vice versa.
15+
16+
To manually trigger a re-index after a significant content addition, use the Algolia Crawler dashboard (requires Algolia account access for `appId: QHP1YG60G0`, `indexName: flarum`).
17+
718
## Testing locally
819

920
Our documentation is generated with [Docusaurus](https://docusaurus.io/docs).

0 commit comments

Comments
 (0)