supabase
supabase copied to clipboard
supabase
feat: docs - added in example description
What kind of change does this PR introduce?
Supabase docs - dart
Issue: #10929
What is the current behavior?
On the examples their is sometimes an description of the example that is not in the docs
What is the new behavior?
The examples now show a description which gives useful tips about the examples:
https://user-images.githubusercontent.com/22655069/207620858-c0f009cb-cc42-4e43-9ac8-2c7c86414277.mov
Additional context
Closes #10929
@Hallidayo is attempting to deploy a commit to the Supabase Team on Vercel.
A member of the Team first needs to authorize it.
![vercel[bot] avatar](https://avatars.githubusercontent.com/in/8329?v=4 "Published by a pub.dev verified publisher"){kind=small}
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated |
|---|---|---|---|---|
| docs | ✅ Ready (Inspect) | Visit Preview | 💬 Add your feedback | Dec 23, 2022 at 4:04AM (UTC) |
| supabase-studio-prod | ✅ Ready (Inspect) | Visit Preview | 💬 Add your feedback | Dec 23, 2022 at 4:04AM (UTC) |
| supabase-studio-staging | ✅ Ready (Inspect) | Visit Preview | 💬 Add your feedback | Dec 23, 2022 at 4:04AM (UTC) |
| zone-www-dot-com | ✅ Ready (Inspect) | Visit Preview | 💬 Add your feedback | Dec 23, 2022 at 4:04AM (UTC) |
1 Ignored Deployment
| Name | Status | Preview | Comments | Updated |
|---|---|---|---|---|
| about | ⬜️ Ignored (Inspect) | Dec 23, 2022 at 4:04AM (UTC) |
nice !!!
@Hallidayo i think we need to clean up the descriptions in the yaml files in /spec first. Some of them have leftover html/jsx in there.
For example. all of this needs removing, and leaving in the top bit of text which is the actual description for the client lib function :D
@MildTomato - Cool, yeah that would look wild without the clean. I'll have a look through and clean up.
@Hallidayo that would be amazing 💯
Think the js v1, js v2, dart v0 and dart v1 spec files are all involved and need cleaning. Luckily it's purely deleting things though which makes it a little enjoyable.
You can ignore any files that are named *--old.yml
@MildTomato cool no problem, I'll do a commit for each spec file so its clear.
@MildTomato - Just had a check of the four spec files and it was only spec/supabase_js_v2.yml that I could see which had some jsx in the descriptions, so I think we should be all good.
Epic @Hallidayo! Thank you for this!
Marked as approved, but it's a big change so I'm going to wait till tomorrow morning to merge it. Appreciated!
I might jump in this branch today and clean up how we display this. Think we can do something better here. We also didn't really hit the actual final design for this so I'll try in figma how the description can fit in
Just want to call out the original issue is "Description of examples is missing in Flutter docs"
But this change appears to be on the JS spec. Will this one solve the linked issue?
@kiwicopple it will. The JS spec file is here b/c it needed cleanup that the others didn't need (for some reason).
@MildTomato something like this make sense? (my mockup on the left, this branch's current state on the right)
