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

Move content to Docusaurus #18

Closed
shawntabrizi opened this issue Jun 30, 2019 · 5 comments
Closed

Move content to Docusaurus #18

shawntabrizi opened this issue Jun 30, 2019 · 5 comments
Assignees

Comments

@shawntabrizi
Copy link
Contributor

This is just a suggestion, but it may make sense to have this content migrated to Docusaurus.

@4meta5, are there advantages to using RustDoc for these recipes?

@4meta5
Copy link
Contributor

4meta5 commented Jul 5, 2019

Just saw this, odd that I wasn't notified earlier. I'll look into migrating to Docusaurus this weekend. I'm reorganizing a lot of the content and using the module-template to yield compileable code samples.

I guess the main advantage of using mdbook is that I'm comfortable with it.

You can also build custom backends with mdbook which might be useful in the future, although I have not yet explored this...

@shawntabrizi
Copy link
Contributor Author

Well before you spend time on the weekend I think it would be good to come up with a final plan. For example, if you are reorganizing content to use the module-template, then it makes sense to use rustdoc right?

And have all the comments and teachings be inline to the code?

Otherwise, I saw that your project is just a bunch of MD files, which should be able to just copy and paste into docusaurus.

@4meta5
Copy link
Contributor

4meta5 commented Jul 5, 2019

I would rather reorganize the content to use the module-template so I'll do that with rustdoc. I think this is the right approach.

@4meta5
Copy link
Contributor

4meta5 commented Jul 8, 2019

todo

  • get compilation on all existing recipes and organize them into separate folder
  • add doc comments and render with rustdoc
  • add unit tests?

@4meta5 4meta5 self-assigned this Jul 8, 2019
@4meta5
Copy link
Contributor

4meta5 commented Aug 22, 2019

I think the current approach (mdbook + kitchen) makes sense. I'm closing this because mdbook works and we can provide a kitchen with compiled examples. I'll open another issue for showing the recipes on the README along with whether the builds work (via travis) AND putting links to the compiled recipe in each section.

@4meta5 4meta5 closed this as completed Aug 22, 2019
robamler pushed a commit to robamler/demo-ml-blockchain-node that referenced this issue Aug 5, 2021
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

2 participants