You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
langchain/docs
Leonid Ganeline 1ab8a14742
docs[patch]: top menu (#13748)
Addressed this issue with the top menu: It allocates too much space. If the screen is small, then the top menu items are split into two lines and look unreadable.
Another issue is with several top menu items: "Chat our docs" and "Also by LangChain". They are compound of several words which also hurts readability. The top menu items should be 1-word size.
Updates:
- "Chat our docs" -> "Chat" (the meaning is clean after clicking/opening the item)
- "Also by LangChain" -> "🦜🔗"
- "🦜🔗" moved before "Chat" item. This new item is partially copied from the first left item, the "🦜🔗 LangChain". This design (with two 🦜🔗 elements, visually splits the top menu into two parts. The first item in each part holds the 🦜🔗 symbols and, when we click the second 🦜🔗 item, it opens the drop-down menu. So, we've got two visually similar parts, which visually split the top menu on the right side: the LangChain Docs (and Doc-related items) and the lift side: other LangChain.ai (company) products/docs.
10 months ago
..
api_reference DOCS: core editable dep api refs (#13747) 10 months ago
docs langchain[minor]: Updated DocugamiLoader, includes breaking changes (#13265) 10 months ago
scripts DOCS: format notebooks (#13371) 10 months ago
src add cookbook table (#12043) 11 months ago
static docs[patch]: update stack diagram (#13902) 10 months ago
.local_build.sh Harrison/docs smith serve (#12898) 10 months ago
README.md Fix typos (#11663) 11 months ago
babel.config.js Restructure docs (#11620) 11 months ago
code-block-loader.js Restructure docs (#11620) 11 months ago
docusaurus.config.js docs[patch]: top menu (#13748) 10 months ago
package-lock.json Upgrade docs postcss (#13031) 10 months ago
package.json Restructure docs (#11620) 11 months ago
settings.ini Restructure docs (#11620) 11 months ago
sidebars.js DOCS: move `adapters` to integrations (#13862) 10 months ago
vercel.json DOCS: move `adapters` to integrations (#13862) 10 months ago
vercel_build.sh template readme's in docs (#13152) 10 months ago
vercel_requirements.txt docs[patch]: install local core (#13990) 10 months ago

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open-source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci