Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Generate docs from code #9974

Closed
5chdn opened this issue Nov 27, 2018 · 3 comments
Closed

Generate docs from code #9974

5chdn opened this issue Nov 27, 2018 · 3 comments
Labels
F5-documentation 📑 Documentation needs fixing, improving or augmenting. F8-enhancement 🎊 An additional feature request. M3-docs 📑 Documentation. P5-sometimesoon 🌲 Issue is worth doing soon.
Milestone

Comments

@5chdn
Copy link
Contributor

5chdn commented Nov 27, 2018

Similar to the JSON-RPC docs that are automatically generated in the CI, we want:

  • chainspec parameters automatically documented
  • config file parameters automatically documented

Whenever there is a change to code, ideally we have scripts that extract the docs from the code and push it to the wiki/config generator.

@5chdn 5chdn added F8-enhancement 🎊 An additional feature request. P5-sometimesoon 🌲 Issue is worth doing soon. F5-documentation 📑 Documentation needs fixing, improving or augmenting. M3-docs 📑 Documentation. labels Nov 27, 2018
@5chdn 5chdn added this to the 2.3 milestone Nov 27, 2018
@5chdn
Copy link
Contributor Author

5chdn commented Nov 27, 2018

Follow-up to #8835

@jam10o-new
Copy link
Contributor

jam10o-new commented Dec 14, 2018

#10067 I'm working on the config file side of this

@5chdn 5chdn modified the milestones: 2.3, 2.4 Jan 10, 2019
@5chdn 5chdn modified the milestones: 2.4, 2.5 Feb 21, 2019
@soc1c soc1c modified the milestones: 2.5, 2.6 Apr 2, 2019
@ordian ordian modified the milestones: 2.6, 2.7 Jul 12, 2019
@adria0
Copy link

adria0 commented Jul 27, 2020

Closing issue due to its stale state.

@adria0 adria0 closed this as completed Jul 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
F5-documentation 📑 Documentation needs fixing, improving or augmenting. F8-enhancement 🎊 An additional feature request. M3-docs 📑 Documentation. P5-sometimesoon 🌲 Issue is worth doing soon.
Projects
None yet
Development

No branches or pull requests

5 participants