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.

Sign up for GitHub

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

Jump to bottom

Add more detail to the synopsis section at the top of the README #2591

Open
gsnider2195 opened this issue Oct 7, 2022 · 1 comment
Open

Add more detail to the synopsis section at the top of the README #2591

gsnider2195 opened this issue Oct 7, 2022 · 1 comment
Labels
hacktoberfest type: documentation Improvements or additions to documentation

Comments

@gsnider2195
Copy link
Contributor

Proposed Changes

Add more of the information from the what is Nautobot section of the documentation to the README.

Some examples from around github

image

image

image

Justification

To help somebody get a quick understanding of what kind of problems they can solve by using Nautobot when they visit the github repo. Technical users will click on the github link first when doing a google search and we should present the information they need up front so they can decide if Nautobot is something that could benefit their environment.
@gsnider2195 gsnider2195 changed the title Add more detail to the synopsis section to the top of the README Add more detail to the synopsis section at the top of the README Oct 7, 2022
@glennmatthews glennmatthews added type: documentation Improvements or additions to documentation hacktoberfest labels Oct 7, 2022
@Santhusha-bit
Copy link
Contributor

Can I work on this issue?

@Santhusha-bit Santhusha-bit mentioned this issue Oct 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hacktoberfest type: documentation Improvements or additions to documentation
Projects
No open projects
Nautobot Core ⚙️
Status: To Groom
Milestone
No milestone
Development

No branches or pull requests
3 participants
@glennmatthews @Santhusha-bit @gsnider2195