langchain/docs/docs_skeleton
Bharat Raghunathan c19a0b9c10
doc(prompts): Follow up on broken Prompt Sublink pages (#8530)
- Description: Follow up of #8478  
  - Issue: #8477
  - Dependencies: None
  - Tag maintainer: @baskaryan
  - Twitter handle: [@BharatR123](twitter.com/BharatR123)

The links were still broken after #8478 and sadly the issue was not
caught with either the Vercel app build and `make docs_linkcheck`
2023-07-31 16:46:13 -07:00
..
docs add guide notebook (#8258) 2023-07-29 09:42:59 -07:00
src Add api cross ref linking (#8275) 2023-07-26 12:38:58 -07:00
static Harrison/update memory docs (#8384) 2023-07-27 17:18:19 -07:00
.gitignore Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
babel.config.js Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
code-block-loader.js Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
docusaurus.config.js use top nav docs (#8090) 2023-07-21 13:52:03 -07:00
generate_api_reference_links.py fix links generation (#8471) 2023-07-29 18:31:33 -07:00
ignore_build.sh fix prod docs build (#6402) 2023-06-18 20:56:12 -07:00
package-lock.json docs: Mendable: Fixes pretty sources not working (#7863) 2023-07-17 18:23:46 -07:00
package.json docs: Mendable: Fixes pretty sources not working (#7863) 2023-07-17 18:23:46 -07:00
README.md Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
settings.ini Doc refactor (#6300) 2023-06-16 11:52:56 -07:00
sidebars.js use top nav docs (#8090) 2023-07-21 13:52:03 -07:00
vercel_build.sh Update local script for docs build (#8377) 2023-07-27 13:13:59 -07:00
vercel.json doc(prompts): Follow up on broken Prompt Sublink pages (#8530) 2023-07-31 16:46:13 -07:00

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