doc: how to add a new search provider

geoblocks · Nov 4, 2024 · 9576c41 · 9576c41
1 parent 7a4bcce
commit 9576c41
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/interfaces/search/ingv-search-provider.ts b/src/interfaces/search/ingv-search-provider.ts
@@ -1,5 +1,12 @@
 import type {Geometry} from 'geojson';
 
+/**
+ * To add a providers, you need to:
+ * 1. Create a new provider file in src/plugins/search/providers/ that implements the INGVSearchProvider interface
+ * 2. Add the provider to the getProvider function in src/plugins/search/ngv-search-providers.ts
+ * 3. Add the provider to the IngvSearchContext in src/interfaces/search/ingv-search-context.ts
+ */
+
 export interface INGVSearchResult {
   title: string;