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

UserList definition missing in README? #47

Open
fredmonroe opened this issue Nov 29, 2024 · 2 comments
Open

UserList definition missing in README? #47

fredmonroe opened this issue Nov 29, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@fredmonroe
Copy link

I think possibly your HTMY templating example in the README for this repo needs the definition of UserList from your htmy repo

@fredmonroe
Copy link
Author

htmy is cool btw thanks for making it and fasthx

@volfpeter
Copy link
Owner

volfpeter commented Nov 29, 2024

Hi,

First of all, thank you!

You're totally right. I was deliberating whether to include everything in examples or not. In the end I decided that since the Jinja example doesn't include the Jinja template itself, I'll also skip the component implementation for HTMY in the readme and only show how to use a component in the decorators. It may be a bad idea.

Actually the full, working example is both in the docs and in the examples folder. Maybe the best solution would be to add a line to each example in the readme with a link to the full, working code.

What do you think? Would you maybe prepare a PR for this change?

I hope you'll like these tools. Feel free to report problems you may bump into, or even better PRs with improvements (there's a lot of room for it especially with htmy).

@volfpeter volfpeter added the documentation Improvements or additions to documentation label Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants