Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Documentation around cache is unclear #3064

Closed
hpachy opened this issue Mar 16, 2023 · 5 comments
Closed

Documentation around cache is unclear #3064

hpachy opened this issue Mar 16, 2023 · 5 comments
Labels
documentation 📖 This needs to be documented but won't need code changes

Comments

@hpachy
Copy link

hpachy commented Mar 16, 2023

I would like to speak about the documentation which is for me very painful to understand... So I'm wondering if I m the only one who's struggling to understand if it's the case ignore and close this issue...

So the thing I really want to do in the Urql is a better documentation about the cache and the implementation / modification of it, with less abstract exemple. I found the documentation very blurry about the utilisation of every function of the cache, the only one I could implemented was the cache.invalide but for the other even after few days of testing still nothing usable for my app

Summary

I proposing to write a documentation we explicite exemple, to make the cache utilisation more easier for beginners like me, seeing some exemple that s can be reproduce can be very help full to understand the cache methodes

Proposed Solution

Sadly I don't have the solution because even days struggling on the docs I still not found the way to update the cache, I just found the way to use cache.invalide but the current probleme I'm facing is to create a new element nested to an object in the cache

@hpachy hpachy added the future 🔮 An enhancement or feature proposal that will be addressed after the next release label Mar 16, 2023
@JoviDeCroock
Copy link
Collaborator

I'm sorry but... this isn't an RFC this is a complaint about the docs 😅 it however would be very valuable feedback if you could point out all the parts of the docs that aren't clear and why.

@kitten
Copy link
Member

kitten commented Mar 16, 2023

If you have more general questions, feel free to drop by our Discord: #3016
I'm also happy to discuss what you'd like to see from the docs there.
In general, if you're looking for runnable examples, we've got for instance this one, which should be modifiable against a testing API:

@hpachy
Copy link
Author

hpachy commented Mar 16, 2023

@JoviDeCroock So sorry...
@kitten I'm gonna try the link you gave me and if I'm still struggling I ll ask on the discord for help...

and if I figured out what was wrong for my comprehension I ll create a new issue to propose a solution

@JoviDeCroock JoviDeCroock added documentation 📖 This needs to be documented but won't need code changes and removed future 🔮 An enhancement or feature proposal that will be addressed after the next release labels Mar 16, 2023
@JoviDeCroock JoviDeCroock changed the title RFC: Your Proposal Documentation around cache is unclear Mar 16, 2023
@hpachy
Copy link
Author

hpachy commented Mar 17, 2023

hello ! so thx to the discord I figured out the solution to my problem so I drop it to help and when I have time I ll make an issue to add more exemple to the doc for a better understanding for beginners :)
https://discord.com/channels/1082378892523864074/1085940813499998288

Thx for the Urql teams once again

@kitten
Copy link
Member

kitten commented Mar 19, 2023

Converting this to a discussion for now, since it's not actionable ✌️

@urql-graphql urql-graphql locked and limited conversation to collaborators Mar 19, 2023
@kitten kitten converted this issue into discussion #3084 Mar 19, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
documentation 📖 This needs to be documented but won't need code changes
Projects
None yet
Development

No branches or pull requests

3 participants