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.

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

Add a tutorial to docs #52

Open
joshuadavidthomas opened this issue Feb 25, 2024 · 1 comment
Open

Add a tutorial to docs #52

joshuadavidthomas opened this issue Feb 25, 2024 · 1 comment
Labels
📝 needs docs Feature or change that requires documentation 💅 nice to have Desirable enhancements that are not critical to the project

Comments

@joshuadavidthomas
Copy link
Member

joshuadavidthomas commented Feb 25, 2024

  • Start with the Django polls tutorial
  • Add a nav without package
    • polls list
    • add new poll (depending on is_staff perm)
    • Admin (depending on is_staff perm)
    • Log out/log in (depending on is_authenticated perm)
  • Refactor to use package
  • List alternatives -- include, custom inclusion template tag, context processor, other packages (django-simple-menu, others on django package's navigation grid)
@joshuadavidthomas
Copy link
Member Author

The alternatives can either be a part of the tutorial itself at the very end, or a separate page entirely.

I'm leaning towards part of the tutorial if only to take the tutorial code and show how it can be done with the alternatives. Though that could also done if it was on it's own, I kind of like the idea of someone going through the tutorial, see the improvements that django-simple-nav brings, then finishing with 'here are other ways to approach the same thing'. Gives a nice overall arc to the tutorial I would think.

@joshuadavidthomas joshuadavidthomas added 📝 needs docs Feature or change that requires documentation 💅 nice to have Desirable enhancements that are not critical to the project labels Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 needs docs Feature or change that requires documentation 💅 nice to have Desirable enhancements that are not critical to the project
Projects
None yet
Development

No branches or pull requests

1 participant