Jon Ross-PerkinsandGeoff Romer
a24816a1f4
Note I'm mostly trying to capture [the docs](https://docs.google.com/document/d/1RRYMm42osyqhI2LyjrjockYCutQ5dOf8Abu50kTrkX0/edit?resourcekey=0-kHyqOESbOHmzZphUbtLrTw&tab=t.0) as they exist today, not fixing issues with the docs. I think the doc itself hasn't changed much lately (i.e., for months). Trying to organize it a little better though, particularly so that it shows up reasonably when looking in github or the website. --------- Co-authored-by: Geoff Romer <gromer@google.com>
Documentation website
Table of contents
Overview
Carbon's main website is the GitHub project page. Carbon remains too early and experimental to have a full-fledged website.
This directories contains infrastructure for building the convenience documentation website, which should be at https://docs.carbon-lang.dev.
Build process
Website generation is done by
gh_pages_deploy.yaml. It runs
prebuild.py, which prepares files for website generation, then builds the
website using Jekyll, configured through _config.yml.
Development tips
rbenv can be used to set up Ruby and bundle.
To run a server, run bundle exec jekyll serve. See
Jekyll docs for more commands.
To update the Gemfile.lock after Gemfile changes, run bundle update.
Domain configuration
The custom domain is configured in three places:
- GitHub organization verified domains
- GitHub repository custom domain
- Google Cloud DNS
- This is visible with
dig docs.carbon-lang.dev
- This is visible with
Note all of these require admin permissions to modify. For sharing test pages, a
GitHub user and repository can be used, pushing to <username>.github.io (or
getting a custom DNS setup).