Documentation refactor #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
susanhooks
requested review from
jvanderaa,
jmcgill298 and
itdependsnetworks
as code owners
jvanderaa
requested changes
Mar 23, 2023
cmsirbu
requested changes
Mar 23, 2023
There was a problem hiding this comment.
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.cssfile can be safely deleted.
jvanderaa
approved these changes
Apr 3, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 -vfrom this branch.