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

Simplify README #54

Open
joshuadavidthomas opened this issue Feb 25, 2024 · 2 comments
Open

Simplify README #54

joshuadavidthomas opened this issue Feb 25, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@joshuadavidthomas
Copy link
Member

Since the docs have finally been setup, the README should be pared back to just a brief intro to the package. All the details currently there should be moved to the docs for further in depth reading.
@joshuadavidthomas joshuadavidthomas added the documentation Improvements or additions to documentation label Feb 25, 2024
@joshuadavidthomas
Copy link
Member Author

joshuadavidthomas commented Feb 26, 2024 •
edited

Structure

  1. Intro
  2. Requirements
  3. Installation
  4. Getting Started
    • Small example with just the basics of the API
    • One NavItem and one NavGroup with no url and one NavItem within it
    • No permissions or extra_context
    • Basic template, no styling
  5. Examples
  6. Documentation
  7. License

@jefftriplett
Copy link
Contributor

Just noting "Getting Started" from the README should probably be mirrored https://django-simple-nav.westervelt.dev/en/latest/getting-started.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jefftriplett @joshuadavidthomas