Qu'est-ce que DocSearch ?

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Pourquoi ?

Nous avons créé DocSearch pour répondre à notre propre besoin. En tant que développeurs, nous passons beaucoup de temps à consulter des documentations, et il peut être difficile de trouver des informations pertinentes dans des documentations volumineuses. Nous ne blâmons personne ici : concevoir une bonne solution de recherche est un vrai défi.

Il se trouve que nous sommes une entreprise spécialisée dans la recherche et que nous possédons une solide expérience dans la création d'interfaces de recherche. Nous voulions utiliser ces compétences pour aider les autres. C'est pourquoi nous avons créé une méthode pour extraire automatiquement le contenu des documentations techniques et le rendre accessible à tous dès la première frappe.

Description rapide

Nous avons divisé DocSearch en un crawler et une bibliothèque frontend.

• Le crawling est géré par le Algolia Crawler et planifié pour s'exécuter une fois par semaine par défaut. Vous pouvez ensuite déclencher de nouveaux crawls et les surveiller directement depuis l'interface du Crawler, qui propose également un éditeur en direct pour maintenir votre configuration.

• La bibliothèque frontend est construite sur Algolia Autocomplete et offre une expérience de recherche immersive via sa modale.

Comment intégrer DocSearch ?

DocSearch est entièrement gratuit et automatisé. La seule chose dont nous avons besoin est que vous lisiez notre checklist et que vous postuliez ! Ensuite, nous partagerons avec vous l'extrait de code nécessaire pour ajouter DocSearch à votre site. Nous vous demandons de conserver le lien "Search by Algolia" visible.

DocSearch est l'une de nos façons de redonner à la communauté open source pour tout ce qu'elle nous a déjà apporté.

Vous pouvez désormais postuler au programme