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

Include documentation as part of the build artifacts #17

Open
ralexstokes opened this issue Feb 2, 2024 · 0 comments
Open

Include documentation as part of the build artifacts #17

ralexstokes opened this issue Feb 2, 2024 · 0 comments

Comments

@ralexstokes
Copy link

It would be nice to include the output of cargo doc in a way users of the repo could easily access it.

I think this is handled well in paradigmxyz/reth, e.g. with this inclusion of cargo doc in the mdbook built with each commit:

https://github.com/paradigmxyz/reth/blob/7e982ef3ad8e6aea004f6a31d450e0debec3cbdf/.github/workflows/book.yml#L80

Another thing to consider is adding user documentation a la the mdbook setup also in the reth repo

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

No branches or pull requests

1 participant