Skip to content

Update documentation for charlie/docs-repo#2

Closed
charliermarsh wants to merge 1 commit intomainfrom
update-docs-charlie-docs-repo--1721079729
Closed

Update documentation for charlie/docs-repo#2
charliermarsh wants to merge 1 commit intomainfrom
update-docs-charlie-docs-repo--1721079729

Conversation

@charliermarsh
Copy link
Copy Markdown
Member

Automated documentation update for charlie/docs-repo

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Jul 15, 2024
@charliermarsh charliermarsh deleted the update-docs-charlie-docs-repo--1721079729 branch July 16, 2024 02:12
charliermarsh added a commit to astral-sh/uv that referenced this pull request Jul 16, 2024
## Summary

This approach is based on https://github.com/PrefectHQ/docs. Rather than
publishing docs in the uv repo, we push to an independent repo that's
used solely to house the docs. In Prefect's case, this allows them to
publish versioned documentation (we should do that too). For us, though,
the benefit is that we can publish the Ruff and uv docs as a single site
(docs.astral.sh).

Prefect clones the source repo and builds the documentation from the
`docs` repo (i.e., the action runs in the `docs` repo). In our case,
I've instead set it up such that the action runs in `uv` (and later in
`ruff` too), clones the `docs` repo, and puts up a PR in that separate
repo. Because of these requirements, we have to use a PAT rather than a
deploy key (as PATs cannot do GitHub-specific things like create PRs --
they can only operate over the Git CLI).

See: astral-sh/docs#2.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant