Setup our docs and host to github pages [CU-868byp419]

[nerdai]

PR Type

Documentation

Short Description

This PR is big (sorry!) but is meant for setting up the docs and its associated processes for development and building/publishing. This PR is less focused on the particular content and sections in the docs, as this is something we should expect to continuously iterate on.

Specifically, what's included:

• docs/: a new directory containing our docs artifacts
• .github/workflows/docs_build.yml for CI/CD build of our docs
• .github/workflows/docs_publish.yml for CI/CD build of our docs
  • Note: our docs will be published from the branch github_pages and will always reflect what's the latest in our main branch. In a future PR, we may want to have docs built on our releases so that we can distinguish between stable and latest versions of docs.

Building and serving the docs locally:

poetry install --with docs
cd docs
make serve

The above will build the docs artifacts and serve them in http://127.0.0.1:8000/

As the image above shows, the current content of docs includes:

• Intro (home page)
• Quickstart
• Module Guides (Incomplete)
• Examples (Incomplete)
• API Reference

Future PRs:

1. Add content to module guides (this is probably a bunch of PRs, tbh) clickup
2. Add content to examples (again, this is probably a bunch of PRs) clickup
3. Revise the content in quickstart -- this is a bit big, and scary in terms of imports for a "quickstart" clickup

For Reviewers:

For this PR, you may find it very helpful to actually checkout this branch and build/serve the docs locally on your machine. In case you're not using this already, I find the gh cli tool to be very helpful for checking out branches associated to a PR.

# install gh cli
brew install gh

After installing you can click the pulldown menu for "Code" at the top of this PR:

And copy and paste the command to checkout this branch on your local machine:

gh pr checkout 313

[vector-admin]

Task linked: CU-868byp419 Initial setup for docs

[emersodb]

Overall, awesome PR...really looking forward to fixing all the documentation rendering warning that are surfaced by this 😂

Just a few small comments and some rendering issues I ran into for whatever reason.

[emersodb]

Assuming you're good with my condensation of the quickstart, I'm good for this to go in.

[nerdai]

Assuming you're good with my condensation of the quickstart, I'm good for this to go in.

More than happy with it! Thanks for doing that.