docs: publish GitHub Pages via Actions and add a landing page - #192
Merged
Merged
Conversation
mkdocs gh-deploy never produced a live site because GITHUB_TOKEN pushes do not trigger Pages. Deploy the built site as a Pages artifact and turn the homepage into a shareable project landing page. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Turns on a live docs/showcase site at https://rajfirke.github.io/provena.
GitHub Pages is already configured for this repo with
build_type: workflow. This PR replacesmkdocs gh-deploy(pushes HTML withGITHUB_TOKEN, which does not trigger Pages) with GitHub's artifact deploy path, and upgradesdocs/index.mdinto a landing page.Checklist
mkdocs build --strictpasses locally)ruff check src/ tests/passes (no Python source changes)ruff format --check src/ tests/passes (no Python source changes)mypy src/provena/passes (no Python source changes)pytestpasses with no failures (no Python source changes)Related Issues
N/A — publishing the existing docs site.