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

Generate website contract docs from Rust docs #86

Open
eloylp opened this issue Oct 8, 2023 · 0 comments
Open

Generate website contract docs from Rust docs #86

eloylp opened this issue Oct 8, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@eloylp
Copy link
Member

eloylp commented Oct 8, 2023

Is your feature request related to a problem? Please describe.

I was adding docs for the website of the governance contract #36 . But felt i was repeating a lot the documentation and wondering how that could be improved.

Describe the solution you'd like

I would like to directly generate the website docs from the Rust code docs. Rust docs are awesome and allow markdown. So i think they could be the source of truth and generate the website ones from them.

Describe alternatives you've considered
To invoke a script that parses the current rust docs rust docs and places a copy in the vercel app folder. This could be triggered by the CI.

It could be good to stablish a custom convention inside Rust docs convention. If done, it would favour the case in which we point the Wizard UI to other contract catalog and is able to load the example commands (now in rust docs) for the invoke buttons.

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant