Feature: linkcheck-action (#534) (#542)

- Add support for local build and linkchecking of docs
- Add GitHub Action to automatically check links before prior to
publication
- Minor reformat of Contributing readme
- Fix existing broken links

Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>

Co-authored-by: Hunter Gerlach <HunterGerlach@users.noreply.github.com>
Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>

docs/modules/chains/combine_docs_how_to.rst

@@ -5,15 +5,15 @@ A chain is made up of links, which can be either primitives or other chains.
 Primitives can be either `prompts <../prompts.html>`_, `llms <../llms.html>`_, `utils <../utils.html>`_, or other chains.
 The examples here are all end-to-end chains for working with documents.
 
-`Question Answering <combine_docs_examples/question_answering.html>`_: A walkthrough of how to use LangChain for question answering over specific documents.
+`Question Answering <./combine_docs_examples/question_answering.html>`_: A walkthrough of how to use LangChain for question answering over specific documents.
 
-`Question Answering with Sources <combine_docs_examples/qa_with_sources.html>`_: A walkthrough of how to use LangChain for question answering (with sources) over specific documents.
+`Question Answering with Sources <./combine_docs_examples/qa_with_sources.html>`_: A walkthrough of how to use LangChain for question answering (with sources) over specific documents.
 
-`Summarization <combine_docs_examples/summarize.html>`_: A walkthrough of how to use LangChain for summarization over specific documents.
+`Summarization <./combine_docs_examples/summarize.html>`_: A walkthrough of how to use LangChain for summarization over specific documents.
 
-`Vector DB Question Answering <combine_docs_examples/vector_db_qa.html>`_: A walkthrough of how to use LangChain for question answering over a vector database.
+`Vector DB Question Answering <./combine_docs_examples/vector_db_qa.html>`_: A walkthrough of how to use LangChain for question answering over a vector database.
 
-`Vector DB Question Answering with Sources <combine_docs_examples/vector_db_qa_with_sources.html>`_: A walkthrough of how to use LangChain for question answering (with sources) over a vector database.
+`Vector DB Question Answering with Sources <./combine_docs_examples/vector_db_qa_with_sources.html>`_: A walkthrough of how to use LangChain for question answering (with sources) over a vector database.
 
 
 .. toctree::
@@ -23,4 +23,4 @@ The examples here are all end-to-end chains for working with documents.
    :name: combine_docs
    :hidden:
 
-   combine_docs_examples/*
+   ./combine_docs_examples/*

docs/modules/chains/generic_how_to.rst

@@ -9,19 +9,19 @@ The examples here are all generic end-to-end chains that are meant to be used to
 
 - **Links Used**: PromptTemplate, LLM
 - **Notes**: This chain is the simplest chain, and is widely used by almost every other chain. This chain takes arbitrary user input, creates a prompt with it from the PromptTemplate, passes that to the LLM, and then returns the output of the LLM as the final output.
-- `Example Notebook <generic/llm_chain.html>`_
+- `Example Notebook <./generic/llm_chain.html>`_
 
 **Transformation Chain**
 
 - **Links Used**: TransformationChain
 - **Notes**: This notebook shows how to use the Transformation Chain, which takes an arbitrary python function and applies it to inputs/outputs of other chains.
-- `Example Notebook <generic/transformation.html>`_
+- `Example Notebook <./generic/transformation.html>`_
 
 **Sequential Chain**
 
 - **Links Used**: Sequential
 - **Notes**: This notebook shows how to combine calling multiple other chains in sequence.
-- `Example Notebook <generic/sequential_chains.html>`_
+- `Example Notebook <./generic/sequential_chains.html>`_
 
 .. toctree::
    :maxdepth: 1
@@ -30,4 +30,4 @@ The examples here are all generic end-to-end chains that are meant to be used to
    :name: generic
    :hidden:
 
-   generic/*
+   ./generic/*

docs/modules/chains/how_to_guides.rst

@@ -6,15 +6,15 @@ Primitives can be either `prompts <../prompts.html>`_, `llms <../llms.html>`_, `
 The examples here are all end-to-end chains for specific applications.
 They are broken up into three categories:
 
-1. `Generic Chains <generic_how_to.html>`_: Generic chains, that are meant to help build other chains rather than serve a particular purpose.
-2. `CombineDocuments Chains <combine_docs_how_to.html>`_: Chains aimed at making it easy to work with documents (question answering, summarization, etc).
-3. `Utility Chains <utility_how_to.html>`_: Chains consisting of an LLMChain interacting with a specific util.
+1. `Generic Chains <./generic_how_to.html>`_: Generic chains, that are meant to help build other chains rather than serve a particular purpose.
+2. `CombineDocuments Chains <./combine_docs_how_to.html>`_: Chains aimed at making it easy to work with documents (question answering, summarization, etc).
+3. `Utility Chains <./utility_how_to.html>`_: Chains consisting of an LLMChain interacting with a specific util.
 
 .. toctree::
    :maxdepth: 1
    :glob:
    :hidden:
 
-   generic_how_to.rst
-   combine_docs_how_to.rst
-   utility_how_to.rst
+   ./generic_how_to.rst
+   ./combine_docs_how_to.rst
+   ./utility_how_to.rst

docs/modules/chains/utility_how_to.rst

@@ -9,44 +9,44 @@ The examples here are all end-to-end chains for specific applications, focused o
 
 - **Links Used**: Python REPL, LLMChain
 - **Notes**: This chain takes user input (a math question), uses an LLMChain to convert it to python code snippet to run in the Python REPL, and then returns that as the result.
-- `Example Notebook <examples/llm_math.html>`_
+- `Example Notebook <./examples/llm_math.html>`_
 
 **PAL**
 
 - **Links Used**: Python REPL, LLMChain
 - **Notes**: This chain takes user input (a reasoning question), uses an LLMChain to convert it to python code snippet to run in the Python REPL, and then returns that as the result.
 - `Paper <https://arxiv.org/abs/2211.10435>`_
-- `Example Notebook <examples/pal.html>`_
+- `Example Notebook <./examples/pal.html>`_
 
 **SQLDatabase Chain**
 
 - **Links Used**: SQLDatabase, LLMChain
 - **Notes**: This chain takes user input (a question), uses a first LLM chain to construct a SQL query to run against the SQL database, and then uses another LLMChain to take the results of that query and use it to answer the original question.
-- `Example Notebook <examples/sqlite.html>`_
+- `Example Notebook <./examples/sqlite.html>`_
 
 **LLMBash Chain**
 
 - **Links Used**: BashProcess, LLMChain
 - **Notes**: This chain takes user input (a question), uses an LLM chain to convert it to a bash command to run in the terminal, and then returns that as the result.
-- `Example Notebook <examples/llm_bash.html>`_
+- `Example Notebook <./examples/llm_bash.html>`_
 
 **LLMChecker Chain**
 
 - **Links Used**: LLMChain
 - **Notes**: This chain takes user input (a question), uses an LLM chain to answer that question, and then uses other LLMChains to self-check that answer.
-- `Example Notebook <examples/llm_checker.html>`_
+- `Example Notebook <./examples/llm_checker.html>`_
 
 **LLMRequests Chain**
 
 - **Links Used**: Requests, LLMChain
 - **Notes**: This chain takes a URL and other inputs, uses Requests to get the data at that URL, and then passes that along with the other inputs into an LLMChain to generate a response. The example included shows how to ask a question to Google - it firsts constructs a Google url, then fetches the data there, then passes that data + the original question into an LLMChain to get an answer.
-- `Example Notebook <examples/llm_requests.html>`_
+- `Example Notebook <./examples/llm_requests.html>`_
 
 **Moderation Chain**
 
 - **Links Used**: LLMChain, ModerationChain
 - **Notes**: This chain shows how to use OpenAI's content moderation endpoint to screen output, and shows how to connect this to an LLMChain.
-- `Example Notebook <examples/moderation.html>`_
+- `Example Notebook <./examples/moderation.html>`_
 
 
 .. toctree::
@@ -56,4 +56,4 @@ The examples here are all end-to-end chains for specific applications, focused o
    :name: generic
    :hidden:
 
-   examples/*
+   ./examples/*