Skip to content

ci: publish API docs to GitHub Pages#952

Merged
Gbangbolaoluwagbemiga merged 3 commits into
HyperSafeD:mainfrom
drips-projects:Docs/Publish-API-reference
Jun 27, 2026
Merged

ci: publish API docs to GitHub Pages#952
Gbangbolaoluwagbemiga merged 3 commits into
HyperSafeD:mainfrom
drips-projects:Docs/Publish-API-reference

Conversation

@Joeloo1

@Joeloo1 Joeloo1 commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR sets up automatic publishing of Rust API documentation to GitHub Pages on tagged releases.

Changes

  • Added GitHub Actions workflow to build and deploy docs on version tags
  • Enhanced Makefile with docs-publish target for CI builds
  • Added API documentation link to README
  • Included implementation summary document

Features

  • Auto-build on tags: Workflow triggers on v* tags
  • GitHub Pages deployment: Uses official actions/deploy-pages action
  • Proper permissions: OIDC-based authentication
  • Index redirect: Root page redirects to main crate docs
  • Manual trigger: Supports workflow dispatch for emergency updates

Published URL

https://hypersafed.github.io/Sanctifier/

Impact

  • Zero breaking changes
  • Minimal maintenance overhead
  • Standard rustdoc output
  • Accessible from README

Closes #787

@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

@Joeloo1 is attempting to deploy a commit to the gbangbolaoluwagbemiga's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Jun 27, 2026

Copy link
Copy Markdown

@Joeloo1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Gbangbolaoluwagbemiga Gbangbolaoluwagbemiga merged commit b4b48f2 into HyperSafeD:main Jun 27, 2026
11 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[contrib-wave] Docs: Publish API reference for sanctifier-core (cargo doc)

2 participants