From 23dd47a4b63a0746edb4ef345ec56572b85b5333 Mon Sep 17 00:00:00 2001 From: Julian Risch Date: Tue, 28 Sep 2021 17:26:32 +0200 Subject: [PATCH 1/2] Remove classifier (until we re-implemented it without FARM) --- docs/latest/menu.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/latest/menu.json b/docs/latest/menu.json index 4b8768109..4fc1b3ef1 100644 --- a/docs/latest/menu.json +++ b/docs/latest/menu.json @@ -26,7 +26,6 @@ {"slug": "reader", "title": "Reader"}, {"slug": "generator", "title": "Generator" }, {"slug": "summarizer", "title": "Summarizer"}, - {"slug": "classifier", "title": "Classifier"}, {"slug": "translator", "title": "Translator"}, {"slug": "knowledge-graph", "title": "Knowledge Graph"}, {"slug": "ranker", "title": "Ranker"}, @@ -122,7 +121,6 @@ { "slug": "pipelines", "title": "Pipelines" }, {"slug": "knowledge-graph", "title": "Knowledge Graph"}, {"slug": "graph-retriever", "title": "Graph Retriever"}, - {"slug": "classifier", "title": "Classifier"}, {"slug": "question-generator", "title": "Question Generator"}, {"slug": "ranker", "title": "Ranker"} ] From f994a985a2cb6a3a96c1107a876ae5b6c19328fc Mon Sep 17 00:00:00 2001 From: Julian Risch Date: Tue, 28 Sep 2021 17:32:15 +0200 Subject: [PATCH 2/2] Explain how to remove page from menu.json --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec958b423..6179f9afc 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ This project makes heavy use of Next.js's [getStaticProps](https://nextjs.org/do ### Overview & Usage Docs -These docs live in the `docs` directory, in the given version directory. The docs are written in .mdx, which allows us to include JSX inside these files. This allows us to add [Headless UI](http://headlessui.dev/) components, a React component library based on Tailwind.css. See the `components/Disclosures` and `components/Tabs` components as examples and how these are used inside of .mdx files such as `docs/v0.9.0/overview/get-started.mdx`. Whenever you want edit or create new documentation, simply do so by adding .mdx files to a given version directory or by editing existing .mdx files. For new files one additional step is required, please add the new page to the `menu.json` file which is located in the folder `docs/vX.X.X`. When you push a branch with your changes to GitHub, Vercel will automatically generate a preview environment for you (check the Vercel Dashboard to find the preview URL). +These docs live in the `docs` directory, in the given version directory. The docs are written in .mdx, which allows us to include JSX inside these files. This allows us to add [Headless UI](http://headlessui.dev/) components, a React component library based on Tailwind.css. See the `components/Disclosures` and `components/Tabs` components as examples and how these are used inside of .mdx files such as `docs/v0.9.0/overview/get-started.mdx`. Whenever you want edit or create new documentation, simply do so by adding .mdx files to a given version directory or by editing existing .mdx files. For new files one additional step is required, please add the new page to the `menu.json` file which is located in the folder `docs/vX.X.X`. In the same way, please remove a page from `menu.json` if it is not needed anymore, e.g., if the corresponding module has been deleted in haystack and therefore its documentation is not needed anymore. When you push a branch with your changes to GitHub, Vercel will automatically generate a preview environment for you (check the Vercel Dashboard to find the preview URL). ### Tutorial & Reference Docs