Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

feat: rust-doc to github pages #1578

Merged
merged 3 commits into from
Sep 4, 2023
Merged

feat: rust-doc to github pages #1578

merged 3 commits into from
Sep 4, 2023

Conversation

ryanycw
Copy link
Contributor

@ryanycw ryanycw commented Aug 30, 2023

Description

This pull request aims to run the cargo doc in CI to generate and publish the doc to GitHub Pages.

Issue Link

Solving #1206

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Contents

The implementation is in .github/workflows/github-pages.yml.
The goal is to generate the doc, upload the doc, and deploy the page.

How Has This Been Tested?

I have tested this in my forked repository.
And here is the demo of what the result will look like.

@github-actions github-actions bot added the CI Issues related to the Continuous Integration mechanisms of the repository. label Aug 30, 2023
@ryanycw
Copy link
Contributor Author

ryanycw commented Aug 30, 2023

Hi @ChihChengLiang, the pull request is good for review. Looking forward to any feedback!

Copy link
Collaborator

@ChihChengLiang ChihChengLiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a nitpick.

.github/workflows/github-pages.yml Show resolved Hide resolved
Copy link
Contributor

@davidnevadoc davidnevadoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ChihChengLiang ChihChengLiang added this pull request to the merge queue Sep 4, 2023
Merged via the queue into privacy-scaling-explorations:main with commit 8de9cd3 Sep 4, 2023
11 checks passed
@ChihChengLiang
Copy link
Collaborator

@ryanycw Thank you for the contribution!

@ryanycw
Copy link
Contributor Author

ryanycw commented Sep 4, 2023

@ChihChengLiang Thank you for the guide throughout the process! I've learned a lot. It was a great start to dive into the project.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CI Issues related to the Continuous Integration mechanisms of the repository.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish the rust-docs in GH pages for easier usage and access
3 participants