The current README provides a good baseline. I'd like us to investigate some of the extras listed below within the context of how all other Nautobot project documentation is presented (via docs.nautobot.com).
Open questions:
[ ] I assume the invoke part (python dependency) is required only for development? Since the project straddles two languages because of Nautobot, it's probably OK. But there is no guidance provided for its usage (consider a go dev coming here with no python knowledge).
[ ] Have you considered building a docs site using mkdocs? Since we're using some python tooling that could be fine to augment the automatic godoc stuff that will be generated by google.
Working from the following checklist:
[x] Reviewed #21 with comments - CS
[ ] Test Customization instructions from scratch - CS
[ ] Test howto main example - CS
[ ] Investigate hosting a docs site based on the nautobot standard docs
[ ] Investigate godoc output (possibly markdown files we could host/integrate with mkdocs?)
The current README provides a good baseline. I'd like us to investigate some of the extras listed below within the context of how all other Nautobot project documentation is presented (via docs.nautobot.com).
Open questions:
Working from the following checklist:
Customizationinstructions from scratch - CS