-
Notifications
You must be signed in to change notification settings - Fork 22
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
Documentation refactor #75
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just the one minor change of format to MD instead of HTML and we are good to go. This looks great!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, thanks for getting this up and running!
A couple of things in addition to the inline comments:
- For consistency (with the other Nautobot related projects), I think we should use the Nautobot logo up top instead of the NTC one. Same goes for the favicon.
Might be easiest to grab them from another repo, like: https://github.com/nautobot/nautobot-plugin-ssot/tree/develop/docs/assets - you might need to update mkdocs.yml with new filenames.
favicon: "assets/favicon.ico"
logo: "assets/nautobot_logo.svg"
- The
docs/extra.css
file can be safely deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, LGTM!
Seeking feedback on documentation refactor. The goal of this PR is to update docs to mkdocs style with NTC branding. The base formatting come from the NTC docs cookiecutter for non-app projects, in progress #here.
You can serve the new docs using
mkdocs serve -v
from this branch.