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

Improve Documentation / Beta Status #7

Open
JuliDi opened this issue Oct 22, 2024 · 2 comments · May be fixed by #8
Open

Improve Documentation / Beta Status #7

JuliDi opened this issue Oct 22, 2024 · 2 comments · May be fixed by #8

Comments

@JuliDi
Copy link

JuliDi commented Oct 22, 2024

Hi,

I feel like this codebase is very solid already (especially has a ton of tests, that's great, thank you!), but it could profit from a bit more documentation. For example about the assumptions regarding how the database is set up.
When I started using it, I was wondering whether or not I would have to create a table or the crate would do it automatically. Turns out it does that automatically and it "just works".

Also, I would like it if the docs were similar to the "offical" session stores like this https://github.com/maxcountryman/tower-sessions-stores/tree/main/sqlx-store

Would you be accepting any PRs aligning this crate's docs (mostly the readme) with the other ones?

And what is missing to get this crate from its "beta" status to "production"?
@rynoV
Copy link
Owner

rynoV commented Oct 22, 2024

Thanks for your feedback

Would definitely accept PRs, agreed docs are lacking

As for the beta status, I just put that there out of caution. I'd like to see the crate used in a long-running server process under real load patterns before claiming it can handle it, even though I can't currently see a reason why it wouldn't work.

@JuliDi
Copy link
Author

JuliDi commented Oct 22, 2024

Great, I will send a PR in a few days :)

Regarding beta: we will hopefully be testing it more thoroughly, but from what I experienced so far, it looks very solid.

@JuliDi JuliDi linked a pull request Oct 22, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DRAFT] Improve documentation and apply clippy lints JuliDi/tower-sessions-surrealdb-store
2 participants
@JuliDi @rynoV