Added docs for the Solidity code #799
Conversation
JuliusBrain
requested review from
jgimeno,
yourheropaul,
rgeraldes and
acroca
|
Can you add the tooling and tasks to the repo so we can reproduce this? And for extra points, could be it be added to the CI so it's always up to date, even if the tooling isn't run locally? |
JuliusBrain
changed the title
JuliusBrain
changed the title
.drone.yml
Outdated
| @@ -374,7 +374,17 @@ pipeline: | |||
| when: | |||
| branch: [dev] | |||
| event: [push] | |||
|
|
|||
|
|
|||
| build_solidity_docs: | |||
There was a problem hiding this comment.
Why do we build the docs in drone? They're not being pushed anywhere. Maybe we can do this step before the assert_no_changes, so we make sure the docs are up to date.
There was a problem hiding this comment.
I can move build_Solidity_docs before go_generate as there is make assert_no_changes.
.drone.yml
Outdated
| group: build_artifacts | ||
| image: kowalatech/solidoc | ||
| commands: | ||
| - make dev_docker_images |
There was a problem hiding this comment.
Do you really need all docker images? maybe just make dev_solidocs_docker_image no? Also I think we can push this image to docker hub so we don't have to build it every time
There was a problem hiding this comment.
That should definitely not be there!
There was a problem hiding this comment.
My mistake using copy-paste!
.drone.yml
Outdated
| group: build_artifacts | ||
| image: kowalatech/solidoc | ||
| commands: | ||
| - make dev_solidocs_docker_image |
There was a problem hiding this comment.
I think we could build this image once and push it to dockerhub instead of building it every time. It could live in a separate repo too.
docs/mkdocs.yml
Outdated
| @@ -51,6 +51,39 @@ pages: | |||
| - Official networks: 'advanced/official-networks.md' | |||
| - Running local testnet: 'advanced/running-local-testnet.md' | |||
| - Minting mining tokens: 'advanced/minting-tokens.md' | |||
| - Smart Contracs: | |||
There was a problem hiding this comment.
Could this be 'Core contracts'? Eventually there will be other contracts in the network.
There was a problem hiding this comment.
I'll change that
|
I've refactored the .drone.yml to generate the solidity docs and give an error if the generated documentation is different. This way, generating the documentation is mandatory for PR commits. |
|
I also added a |
A short summary.
Added generated documentation for the Solidity code.