Merge pull request #3 from cohere-ai/fern/xml-audit

fix: sitemap mismatches
cohere-ai · Jul 22, 2024 · e5a99f2 · e5a99f2
2 parents 8fd02cd + 1bfc989
commit e5a99f2
Show file tree

Hide file tree

Showing 3 changed files with 303 additions and 36 deletions.
diff --git a/fern/docs.yml b/fern/docs.yml
@@ -78,46 +78,14 @@ tabs:
   release-notes:
     display-name: Release Notes
     changelog: pages/changelog
-    slug: release-notes
+    slug: changelog
   llmu:
     display-name: LLMU
     href: https://cohere.com/llmu
   cookbooks:
     display-name: Cookbooks
     slug: page
 
-redirects:
-  - source: "/docs/llmu{/:path}*"
-    destination: "https://cohere.com/llmu"
-  - source: "/docs/multi-hop-tool-use"
-    destination: "/docs/multi-step-tool-use"
-  - source: "/docs/command"
-    destination: "/docs/command-r-plus"
-  - source: "/docs/prompt-engineering"
-    destination: "/docs/crafting-effective-prompts"
-  - source: "/docs/prompt-library"
-    destination: "/docs/create-csv-data-from-json-data"
-  - source: "/docs/rag-connectors"
-    destination: "/docs/overview-1"
-  - source: "/docs/reranking"
-    destination: "/docs/overview"
-  - source: "/reference/rerank-1"
-    destination: "/reference/rerank"
-  - source: "/docs/generation-card"
-    destination: "/docs/generation-benchmarks"
-  - source: "/reference/datasets"
-    destination: "/reference/create-dataset"
-  - source: "/reference/connectors"
-    destination: "/reference/list-connectors"
-  - source: "/reference/embed-jobs"
-    destination: "/reference/create-embed-job"
-  - source: "/reference/finetuning"
-    destination: "/reference/listfinetunedmodels"
-  - source: "/reference/model"
-    destination: "/reference/get-models"
-  - source: "/classify-reference"
-    destination: "reference/classify"
-
 landing-page:
   page: Cohere Documentation
   path: pages/index.mdx
@@ -154,6 +122,7 @@ navigation:
           - page: Rerank
             path: pages/models/rerank-2.mdx
       - section: Text Generation
+        skip-slug: true
         contents:
           - page: Using the Chat API
             path: pages/text-generation/chat-api.mdx
@@ -167,9 +136,11 @@ navigation:
             path: pages/text-generation/retrieval-augmented-generation-rag.mdx
           - section: Tool Use
             path: pages/text-generation/tools.mdx
+            skip-slug: true
             contents:
               - section: Multi-step Tool Use (Agents)
                 path: pages/text-generation/tools/multi-step-tool-use.mdx
+                skip-slug: true
                 contents:
                   - page: Implementing a Multi-Step Agent with Langchain
                     path: pages/text-generation/tools/multi-step-tool-use/implementing-a-multi-step-agent-with-langchain.mdx
@@ -748,7 +719,8 @@ navigation:
               - section: "/check-api-key"
                 skip-slug: true
                 contents:
-                  - POST /v1/check-api-key
+                  - endpoint: POST /v1/check-api-key
+                    slug: checkapikey
               - finetuning:
                   title: "/finetuning"
                   skip-slug: true
@@ -866,3 +838,298 @@ experimental:
   mdx-components:
     - ./components
     - ./icons
+
+redirects:
+  # fern redirect rules
+  - source: "/docs/llmu{/:path}*"
+    destination: "https://cohere.com/llmu"
+  - source: "/docs/multi-hop-tool-use"
+    destination: "/docs/multi-step-tool-use"
+  - source: "/docs/command"
+    destination: "/docs/command-r-plus"
+  - source: "/docs/prompt-engineering"
+    destination: "/docs/crafting-effective-prompts"
+  - source: "/docs/prompt-library"
+    destination: "/docs/create-csv-data-from-json-data"
+  - source: "/docs/rag-connectors"
+    destination: "/docs/overview-rag-connectors"
+  - source: "/docs/overview-1"
+    destination: "/docs/overview-rag-connectors"
+  - source: "/docs/reranking"
+    destination: "/docs/overview"
+  - source: "/reference/rerank-1"
+    destination: "/reference/rerank"
+  - source: "/docs/generation-card"
+    destination: "/docs/generation-benchmarks"
+  - source: "/reference/datasets"
+    destination: "/reference/create-dataset"
+  - source: "/reference/connectors"
+    destination: "/reference/list-connectors"
+  - source: "/reference/embed-jobs"
+    destination: "/reference/create-embed-job"
+  - source: "/reference/finetuning"
+    destination: "/reference/listfinetunedmodels"
+  - source: "/reference/model"
+    destination: "/reference/get-models"
+  - source: "/classify-reference"
+    destination: "reference/classify"
+  - source: "/reference/generate-1"
+    destination: "/reference/generate"
+  - source: "/reference/summarize-2"
+    destination: "/reference/summarize"
+
+  # migrated redirect rules
+  - source: /docs/sitemap.xml
+    destination: /sitemap.xml
+  - source: /api-reference
+    destination: /reference/about
+  - source: /bpe-tokens-wiki
+    destination: /docs/tokens
+  - source: /classify-content-mod
+    destination: /docs/content-moderation-with-classify
+  - source: /classify-reference
+    destination: /reference/classify
+  - source: /cli-auth
+    destination: /reference/auth
+  - source: /cli-finetune
+    destination: /reference/finetune
+  - source: /cli-key
+    destination: /reference/key
+  - source: /cli-model
+    destination: /reference/model
+  - source: /customer-support
+    destination: /reference/customer-support
+  - source: /custom-model-metrics
+    destination: /docs/custom-model-metrics
+  - source: /custom-model-troubleshooting
+    destination: /docs/training-troubleshooting
+  - source: /data-statement
+    destination: /docs/data-statement
+  - source: /detokenize-reference
+    destination: /reference/detokenize
+  - source: /docs/finetune-troubleshooting
+    destination: /docs/training-troubleshooting
+  - source: /docs/train-a-representation-model
+    destination: /docs/training-a-representation-model
+  - source: /embedding-wiki
+    destination: /docs/embeddings
+  - source: /embed-reference
+    destination: /reference/embed
+  - source: /entity-extraction
+    destination: /docs/entity-extraction
+  - source: /environmental-impact
+    destination: /docs/environmental-impact
+  - source: /errors-reference
+    destination: /reference/errors
+  - source: /finetuning-wiki
+    destination: /docs/training-custom-models
+  - source: /ft-wiki
+    destination: /docs/training-custom-models
+  - source: /generate-reference
+    destination: /reference/generate
+  - source: /generation-card
+    destination: /docs/generation-card
+  - source: /going-live
+    destination: /docs/going-live
+  - source: /harm-prevention
+    destination: /docs/responsible-use
+  - source: /intent-recognition
+    destination: /reference/intent-recognition
+  - source: /intro-to-llms
+    destination: /docs/introduction-to-large-language-models
+  - source: /learn
+    destination: /docs
+  - source: /likelihood-eval
+    destination: /docs/likelihood-evaluation
+  - source: /likelihood-wiki
+    destination: /docs/likelihood
+  - source: /num-gens-wiki
+    destination: /docs/number-of-generations
+  - source: /playground-overview
+    destination: /docs/playground-overview
+  - source: /prompt-engineering
+    destination: /docs/prompt-engineering
+  - source: /prompt-engineering-wiki
+    destination: /docs/prompt-engineering
+  - source: /reference/generate-2
+    destination: /reference/text-summarization-example
+  - source: /release-notes
+    destination: /changelog
+  - source: /representation-card
+    destination: /docs/representation-card
+  - source: /responsible-use
+    destination: /docs/responsible-use
+  - source: /semantic-search
+    destination: /docs/semantic-search
+  - source: /sentiment-analysis-example
+    destination: /docs/text-classification-with-classify
+  - source: /sentiment-analysis-guide
+    destination: /reference/sentiment-analysis
+  - source: /summarization_example
+    destination: /reference/text-summarization-example
+  - source: /teams-roles
+    destination: /reference/teams-and-roles
+  - source: /temperature-wiki
+    destination: /docs/temperature
+  - source: /text-classification
+    destination: /docs/text-classification-with-classify
+  - source: /text-classification-embeddings
+    destination: /docs/text-classification-with-embed
+  - source: /text-summarization-example
+    destination: /docs/text-summarization
+  - source: /tokenize-reference
+    destination: /reference/tokenize
+  - source: /token-picking
+    destination: /docs/controlling-generation-with-top-k-top-p
+  - source: /training-a-generative-model
+    destination: /docs/training-a-generative-model
+  - source: /training-custom-models
+    destination: /docs/training-custom-models
+  - source: /training-generation-models
+    destination: /docs/training-a-generative-model
+  - source: /training-representation-models
+    destination: /docs/training-a-representation-model
+  - source: /tutorials-and-guides
+    destination: /docs/the-cohere-platform
+  - source: /usage-guidelines
+    destination: /docs/usage-guidelines
+  - source: /versioning-reference
+    destination: /reference/versioning
+  - source: /api-reference
+    destination: /reference/about
+  - source: /bpe-tokens-wiki
+    destination: /docs/tokens
+  - source: /classify-content-mod
+    destination: /docs/content-moderation-with-classify
+  - source: /classify-reference
+    destination: /reference/classify
+  - source: /cli-auth
+    destination: /reference/auth
+  - source: /cli-finetune
+    destination: /reference/finetune
+  - source: /cli-key
+    destination: /reference/key
+  - source: /cli-model
+    destination: /reference/model
+  - source: /command
+    destination: /reference/command
+  - source: /customer-support
+    destination: /reference/customer-support
+  - source: /custom-model-metrics
+    destination: /docs/custom-model-metrics
+  - source: /custom-model-troubleshooting
+    destination: /docs/training-troubleshooting
+  - source: /data-statement
+    destination: /docs/data-statement
+  - source: /detokenize-reference
+    destination: /reference/detokenize
+  - source: /docs/finetune-troubleshooting
+    destination: /docs/training-troubleshooting
+  - source: /docs/train-a-representation-model
+    destination: /docs/training-a-representation-model
+  - source: /embedding-wiki
+    destination: /docs/embeddings
+  - source: /embed-reference
+    destination: /reference/embed
+  - source: /entity-extraction
+    destination: /docs/entity-extraction
+  - source: /environmental-impact
+    destination: /docs/environmental-impact
+  - source: /errors-reference
+    destination: /reference/errors
+  - source: /finetuning-representation-models/
+    destination: /docs/training-a-representation-model
+  - source: /finetuning-wiki
+    destination: /docs/training-custom-models
+  - source: /ft-wiki
+    destination: /docs/training-custom-models
+  - source: /generate-reference
+    destination: /reference/generate
+  - source: /generation-card
+    destination: /docs/generation-card
+  - source: /going-live
+    destination: /docs/going-live
+  - source: /harm-prevention
+    destination: /docs/responsible-use
+  - source: /intent-recognition
+    destination: /reference/intent-recognition
+  - source: /intro-to-llms
+    destination: /docs/introduction-to-large-language-models
+  - source: /intro-to-llms/
+    destination: /intro-to-llms
+  - source: /learn
+    destination: /docs
+  - source: /likelihood-eval
+    destination: /docs/likelihood-evaluation
+  - source: /likelihood-wiki
+    destination: /docs/likelihood
+  - source: /num-gens-wiki
+    destination: /docs/number-of-generations
+  - source: /playground-overview
+    destination: /docs/playground-overview
+  - source: /prompt-engineering
+    destination: /docs/prompt-engineering
+  - source: /prompt-engineering-wiki
+    destination: /docs/prompt-engineering
+  - source: /prompt-engineering-wiki/
+    destination: /docs/prompt-engineering
+  - source: /reference/generate-2
+    destination: /reference/text-summarization-example
+  - source: /release-notes
+    destination: /changelog
+  - source: /representation-card
+    destination: /docs/representation-card
+  - source: /responsible-use
+    destination: /docs/responsible-use
+  - source: /semantic-search
+    destination: /docs/semantic-search
+  - source: /semantic-search/
+    destination: /docs/semantic-search
+  - source: /sentiment-analysis-example
+    destination: /docs/text-classification-with-classify
+  - source: /sentiment-analysis-guide
+    destination: /reference/sentiment-analysis
+  - source: /summarization_example
+    destination: /reference/text-summarization-example
+  - source: /teams-roles
+    destination: /reference/teams-and-roles
+  - source: /temperature-wiki
+    destination: /docs/temperature
+  - source: /text-classification
+    destination: /docs/text-classification-with-classify
+  - source: /text-classification-embeddings
+    destination: /docs/text-classification-with-embed
+  - source: /text-classification-embeddings/
+    destination: /docs/text-classification-with-embed
+  - source: /text-summarization-example
+    destination: /docs/text-summarization
+  - source: /tokenize-reference
+    destination: /reference/tokenize
+  - source: /token-picking
+    destination: /docs/controlling-generation-with-top-k-top-p
+  - source: /token-picking/
+    destination: /docs/controlling-generation-with-top-k-top-p
+  - source: /training-a-generative-model
+    destination: /docs/training-a-generative-model
+  - source: /training-custom-models
+    destination: /docs/training-custom-models
+  - source: /training-generation-models
+    destination: /docs/training-a-generative-model
+  - source: /training-representation-models
+    destination: /docs/training-a-representation-model
+  - source: /tutorials-and-guides
+    destination: /docs/the-cohere-platform
+  - source: /usage-guidelines
+    destination: /docs/usage-guidelines
+  - source: /versioning-reference
+    destination: /reference/versioning
+  - source: /docs/coral-toolkit
+    destination: /docs/cohere-toolkit
+  - source: /docs/generation-card
+    destination: /docs/generation-benchmarks
+  - source: /docs/representation-card
+    destination: /docs/representation-benchmarks
+  - source: /docs/training-custom-models
+    destination: /docs/fine-tuning
+  - source: /docs/embed-2
+    destination: /docs/cohere-embed
diff --git a/fern/fern.config.json b/fern/fern.config.json
@@ -1,4 +1,4 @@
 {
   "organization": "cohere",
-  "version": "0.31.25-rc1"
+  "version": "0.33.3"
 }
diff --git a/fern/pages/text-generation/connectors/overview-1.mdx b/fern/pages/text-generation/connectors/overview-1.mdx
@@ -1,6 +1,6 @@
 ---
 title: "Overview"
-slug: "docs/overview-1"
+slug: "docs/overview-rag-connectors"
 
 hidden: false
 createdAt: "Thu May 23 2024 05:06:54 GMT+0000 (Coordinated Universal Time)"