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

Fully automate the generation of the reference section #77

Open
fiiiu opened this issue Jun 6, 2018 · 0 comments
Open

Fully automate the generation of the reference section #77

fiiiu opened this issue Jun 6, 2018 · 0 comments
Labels
kind:documentation Documentation!
Milestone

Comments

@fiiiu
Copy link
Contributor

fiiiu commented Jun 6, 2018

Right now, the reference section is generated in a partially automated form, using gen-docs for zos-cli, and solidity-docgen for zos-lib, and then pruning the corresponding outcomes and merging them manually.

We need to provide a script to do all of this, plus maybe the deployment, in a fully automated way. This will likely be most easily achieved by tweaking gen-docs (zeppelinos/zos-cli#143) and solidity-docgen to conform to the required pattern, and then simply merge with a script.

This pertains the generation of the .md files in the docs/docs/ folder, as well as the sidebars.json file. Finally, this is the first step towards having automated versioning for the docs (#78).

@fiiiu fiiiu added the kind:documentation Documentation! label Jun 6, 2018
@fiiiu fiiiu added this to the Backlog milestone Jun 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation Documentation!
Projects
None yet
Development

No branches or pull requests

1 participant