Build Docs on Docs.rs With Example Contracts

[nlordell]

Docs.rs documentation currently does not include smart contracts. I am unsure whether or not the Docs.rs will be able to build the truffle project (might not even have node installed) so we might have to include the built truffle project in the repo :cry:

@fleupold @bh2smith any ideas?

[fleupold]

I don't fully understand. Why does docs.rs need to build the truffle project?

Would we be able to just include the example json file in the samples folder? I think that would be ok.

[bh2smith]

Would we be able to just include the example json file in the samples folder?

This works for me too.

[nlordell]

So, currently we have a truffle project with sample contracts that we use for the async example and for docs (with the samples feature). These depend on the built truffle artifacts. Docs.rs builds documentation on their build machines which do not have NPM installed, so we would be unable to build this truffle project.

The solution, as you guys said, would be to include truffle compiled contracts in the repository. That just feels icky to me as in general it would be nice to avoid checking-in build artifacts.

[bh2smith]

I believe the suggestion would be to provide the example material with out the compiled stuff and give the user a guide on how they can generate all this stuff on their own.