Skip to content
This repository has been archived by the owner on Oct 20, 2022. It is now read-only.

Remove classifier (until we re-implemented it without FARM) #168

Merged
merged 2 commits into from
Sep 28, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Explain how to remove page from menu.json
  • Loading branch information
julian-risch committed Sep 28, 2021
commit f994a985a2cb6a3a96c1107a876ae5b6c19328fc
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:https://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:https://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

Expand Down