chore: rename categories in the API docs (#6885)

* rename API categories

* fix

* update slugs

* rename files for consistency

* fix category ID

* try getting the right version

.github/workflows/readme_sync.yml

@@ -41,4 +41,4 @@ jobs:
         env:
           README_API_KEY: ${{ secrets.README_API_KEY }}
         with:
-          rdme: docs ./docs/pydoc/temp --key="$README_API_KEY" --version=2.0
+          rdme: docs ./docs/pydoc/temp --key="$README_API_KEY" --version=v2.0

docs/pydoc/config/audio_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Transcribes audio files.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: WhisperTranscriber API
+  title: Audio
-  slug: whisper-transcriber-api
+  slug: audio-api
   order: 180
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: whisper_transcriber_api.md
+    filename: audio_api.md

docs/pydoc/config/builders_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Extract the output of a Generator to an Answer format, and build prompts.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Builder API
+  title: Builders
-  slug: builder-api
+  slug: builders-api
   order: 5
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: builder_api.md
+    filename: builders_api.md

docs/pydoc/config/caching_api.yml

@@ -14,8 +14,8 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Checks if any document coming from the given URL is already present in the store.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: CacheChecker API
+  title: Caching
   slug: caching-api
   order: 7
   markdown:
@@ -23,4 +23,4 @@ renderer:
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: caching_api.md
+    filename: cachings_api.md

docs/pydoc/config/classifiers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Detects the language of the Documents and routes them appropriately.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Classifier API
+  title: Classifiers
-  slug: classifier-api
+  slug: classifiers-api
   order: 10
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: classifier_api.md
+    filename: classifiers_api.md

docs/pydoc/config/converters_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Extracts text from files in different formats and converts it into a unified Document format.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Converter API
+  title: Converters
-  slug: converter-api
+  slug: converters-api
   order: 20
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: converter_api.md
+    filename: converters_api.md

docs/pydoc/config/data_classess_api.yml

@@ -14,8 +14,8 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Core classes that carry data through the system.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Data Classes API
+  title: Data Classes
   slug: data-classes-api
   order: 30
   markdown:
@@ -23,4 +23,4 @@ renderer:
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: data_classes_api.md
+    filename: data_classess_api.md

docs/pydoc/config/document_stores_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Stores your texts and meta data and provides them to the Retriever at query time.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: DocumentStore API
+  title: Document Stores
-  slug: document-store-api
+  slug: document-stores-api
   order: 40
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: document_store.md
+    filename: document_stores_api.md

docs/pydoc/config/document_writers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Writes Documents to a DocumentStore.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: DocumentWriter API
+  title: Document Writers
-  slug: writer-api
+  slug: document-writers-api
   order: 50
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: writer_api.md
+    filename: document_writers_api.md

docs/pydoc/config/embedders_api.yml

@@ -24,13 +24,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Transforms queries into vectors to look for similar or relevant Documents.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Embedder API
+  title: Embedders
-  slug: embedder-api
+  slug: embedders-api
   order: 60
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: embedder_api.md
+    filename: embedders_api.md

docs/pydoc/config/extractors_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Extracts predefined entities out of a piece of text.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Extractor API
+  title: Extractors
-  slug: extractor-api
+  slug: extractors-api
   order: 65
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: extractor_api.md
+    filename: extractors_api.md

docs/pydoc/config/fetchers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Fetches content from a list of URLs and returns a list of extracted content streams.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: LinkContentFetcher API
+  title: Fetchers
-  slug: fetcher-api
+  slug: fetchers-api
   order: 80
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: fetcher_api.md
+    filename: fetchers_api.md

docs/pydoc/config/generators_api.yml

@@ -25,13 +25,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Enables text generation using LLMs.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Generator API
+  title: Generators
-  slug: generator-api
+  slug: generators-api
   order: 70
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: generator_api.md
+    filename: generators_api.md

docs/pydoc/config/joiners_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Routes data to the right component based on its file type or metadata.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Joiner API
+  title: Joiners
-  slug: joiner-api
+  slug: joiners-api
   order: 75
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: joiner_api.md
+    filename: joiners_api.md

docs/pydoc/config/others_api.yml

@@ -14,9 +14,9 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Other utility components for Haystack Pipelines.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Other Components API
+  title: Other Components
-  slug: others
+  slug: others-api
   order: 85
   markdown:
     descriptive_class_title: false

docs/pydoc/config/pipeline_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Arranges components and integrations in flow.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Pipelines API
+  title: Pipeline
-  slug: pipelines-api
+  slug: pipeline-api
   order: 90
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: pipelines_api.md
+    filename: pipeline_api.md

docs/pydoc/config/preprocessors_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Normalizes white spaces, gets rid of headers and footers, cleans empty lines in your Documents, or splits them into smaller pieces.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: PreProcessor API
+  title: PreProcessors
-  slug: preprocessor-api
+  slug: preprocessors-api
   order: 100
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: preprocessor_api.md
+    filename: preprocessors_api.md

docs/pydoc/config/rankers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Reorders a set of Documents based on their relevance to the query.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Ranker API
+  title: Rankers
-  slug: ranker-api
+  slug: rankers-api
   order: 110
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: ranker_api.md
+    filename: rankers_api.md

docs/pydoc/config/readers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Takes a query and a set of Documents as input and returns ExtractedAnswers by selecting a text span within the Documents.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Reader API
+  title: Readers
-  slug: reader-api
+  slug: readers-api
   order: 120
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: reader_api.md
+    filename: readers_api.md

docs/pydoc/config/retrievers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Sweeps through a Document Store and returns a set of candidate Documents that are relevant to the query.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Retriever API
+  title: Retrievers
-  slug: retriever-api
+  slug: retrievers-api
   order: 130
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: retriever_api.md
+    filename: retrievers_api.md

docs/pydoc/config/routers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Routes data to the right component based on its file type or metadata.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Router API
+  title: Routers
-  slug: router-api
+  slug: routers-api
   order: 140
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: router_api.md
+    filename: routers_api.md

docs/pydoc/config/samplers_api.yml

@@ -14,13 +14,13 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Filters documents based on their similarity scores using top-p sampling.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: TopPSampler API
+  title: Samplers
-  slug: sampler-api
+  slug: samplers-api
   order: 150
   markdown:
     descriptive_class_title: false
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: sampler_api.md
+    filename: samplers_api.md

docs/pydoc/config/websearch_api.yml

@@ -14,8 +14,8 @@ processors:
 renderer:
   type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
   excerpt: Web search engine for Haystack.
-  category_slug: haystack-classes
+  category_slug: haystack-api
-  title: Websearch API
+  title: Websearch
   slug: websearch-api
   order: 170
   markdown: