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

THANK YOU but can I help with the docs? #43

Open
maikelthedev opened this issue Jan 9, 2025 · 1 comment
Open

THANK YOU but can I help with the docs? #43

maikelthedev opened this issue Jan 9, 2025 · 1 comment

Comments

@maikelthedev
Copy link

maikelthedev commented Jan 9, 2025

Hi Sergio, thank you for coding this, it's helped me with the most obvious testing use case that Phoenix somehow completely ignores. It should be part of vanilla phoenix testing.

Either way. I know how to use your code because of the (very strange) page you have on how to use it.

Strange because: no directory of articles, no "how to find you" page, even clicking on you as the author of this just takes me to this page which is again just your blog posts https://arbeo.dev/author/sergio/

Anyway, moving on.

THE DOCS

Yet so far understanding how to use this hex package is is reading that Twenty Twenty-Five themed standard Wordpress blog because the Hexdocs aren't clear enough and I was wondering:

Can we do something about it?

I'm happy to help.

Gracias de antemano.

@Serabe
Copy link
Owner

Serabe commented Jan 9, 2025

Yeah! Let me use this comment to serve as a roadmap for 1.0

Before holidays, I worked on #42 that simplifies the problem of creating your own mock view. This is was in response to issue #39 (Surface compatibility). I'd be waiting till February for an answer, or consider it done and fixable in the future if needed (Surface does not support LV 1.0 yet and I have a limited amount of spare time, did not want it to spend on a library I don't intend to use on my projects).

On early February, I'll release 0.10. I expect that to be the final version before 1.0.

For v1.0 I want to:

  • Add some deprecations, specially around live_isolated_component receiving just a map and not some keywords.
  • Add a cookbook or some cheat sheets to the documentation and going through the existing documentation again specially the README. Add a notice about which versions will be supported after 1.0
  • Drop old versions of Elixir, OTP, and Phoenix Live View from the support matrix.

That said, how to help?

I'd like to know:

  • What are your current problems when working with live_isolated_component?
  • What has been limiting in the current documentation?
  • Is there anything you'd like to do but cannot do?
  • What improvements you wish the current project (be it features or docs) had?

Any comment is more than welcomed. Depending on them, I can guide you on how to address them!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants