Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WEB3-321: feat: deploy steel docs on github pages #419

Merged
merged 20 commits into from
Jan 29, 2025
Merged

WEB3-321: feat: deploy steel docs on github pages #419

merged 20 commits into from
Jan 29, 2025

Conversation

nahoc
Copy link
Contributor

@nahoc nahoc commented Jan 27, 2025

This deploys a custom docs.rs like doc site for steel using GitHub pages and cargo doc

@github-actions github-actions bot changed the title feat: deploy steel docs on github pages WEB3-321: feat: deploy steel docs on github pages Jan 27, 2025
@nahoc nahoc marked this pull request as ready for review January 27, 2025 18:45
@nahoc nahoc requested a review from a team as a code owner January 27, 2025 18:45
@nahoc nahoc requested a review from nategraf January 27, 2025 18:45
Copy link
Contributor

@nategraf nategraf left a comment

Choose a reason for hiding this comment

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

When we are building for publishing, we'd like to use --cfg docsrs and --all-features so that features under flags like unstable-history show up and are marked as requiring a feature flag.
https://github.com/risc0/risc0-ethereum/blob/main/.github/workflows/main.yml#L251

.github/workflows/steel-documentation.yml Outdated Show resolved Hide resolved
@nahoc
Copy link
Contributor Author

nahoc commented Jan 28, 2025

When we are building for publishing, we'd like to use --cfg docsrs and --all-features so that features under flags like unstable-history show up and are marked as requiring a feature flag. https://github.com/risc0/risc0-ethereum/blob/main/.github/workflows/main.yml#L251

Made the changes based on the code you linked, seems to work but lmk if I need to change anything else
https://risc0.github.io/risc0-ethereum/risc0_steel/index.html

@nahoc nahoc requested a review from nategraf January 28, 2025 00:43
@nategraf
Copy link
Contributor

So, the links in the README lead to 404. This is not specific to the work, but if you have time to look into solutions there, it would be appreciated. Maybe we should just link back to GitHub. Maybe we should have something like what clap does for their docs https://docs.rs/clap/latest/clap/_derive/index.html

@nahoc
Copy link
Contributor Author

nahoc commented Jan 28, 2025

So, the links in the README lead to 404. This is not specific to the work, but if you have time to look into solutions there, it would be appreciated. Maybe we should just link back to GitHub. Maybe we should have something like what clap does for their docs https://docs.rs/clap/latest/clap/_derive/index.html

Right, so the easiest way to make this work atm is just to use absolute links instead of relative in markdown.

Otherwise I'll try digging a bit to see if I can find something.

@nategraf nategraf enabled auto-merge (squash) January 29, 2025 01:05
@nategraf nategraf merged commit 888ebd4 into main Jan 29, 2025
11 checks passed
@nategraf nategraf deleted the steel-docs branch January 29, 2025 01:10
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.

2 participants