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

Fix 404s on Rustdocs for auraed #492

Merged
merged 4 commits into from
Jan 14, 2024

Conversation

mccormickt
Copy link
Contributor

The below pages were 404s on the website.

This PR removes the unused /macros and /implementors routes and unifies the rustdocs to fix the documentation. Includes some drive-by typo fixes.

@@ -315,7 +315,7 @@ endif

.PHONY: docs-crates
docs-crates: musl $(GEN_TS) $(GEN_RS) ## Build the crate (documentation)
$(cargo) doc --target $(uname_m)-unknown-linux-musl --no-deps --package auraed
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if this breaks anything. Assuming our CI would run with the correct rust target by default, I think we're fine. This change allows all the rustdocs to be unified and have links to each crate on the left navigation.

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if this breaks anything. Assuming our CI would run with the correct rust target by default, I think we're fine. This change allows all the rustdocs to be unified and have links to each crate on the left navigation.

image

it shouldn't, no. our ci doesn't use the right target (musl) but for docs I suspect it doesnt matter...

@dmah42
Copy link
Contributor

dmah42 commented Jan 14, 2024

the unused import should be unrelated (and I'm not sure how it snuck in). let me see if I can clean that up first.

@dmah42 dmah42 merged commit 793eae0 into aurae-runtime:main Jan 14, 2024
10 of 11 checks passed
@mccormickt mccormickt deleted the mccormickt/fix-docs branch January 20, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants