-
-
Notifications
You must be signed in to change notification settings - Fork 253
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
[docs] Toolpad docs part 1 #859
Conversation
Your Render PR Server URL is https://toolpad-pr-859.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-cc4am2b19n0agdht37vg. |
Signed-off-by: Siriwat K <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to see more documentation :)
Closes #834
I'm not sure about how much work this represents. If it's a big effort, I think that we should change this to: "One step toward #834". So we can have small PRs that we merge incrementally.
Regarding who should review this PR, would it make sense to have, Prakhar & Jan for the product side and maybe Sam for the technical writing dimension in the first few PRs to the point where most of the best practices have been shared?
Co-authored-by: Olivier Tassinari <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
A couple of suggestions for consideration. Should we replace:
based on: |
alternatively:
|
I can definitely do that, I'm just not sure how fast we can merge this one then so I wouldn't blocked to open new ones. Or maybe this can be merged and still kept for feedback that I could deliver in a follow up PRs?
Yeah, I think it makes sense, in general the more people look the better as I might have missed some things, might have explained something how I understand but maybe it's not how it actually is, etc...
I'm wondering if we are sure that the UI for that will not change? Are we going to keep using "drawer" in the future as well? I was thinking about more "universal" name that would not depend on the implementation 🤔 For no.5 - I like Jan's proposal for "Explorer" or basically looking for analogy in other products. Quick search gave me this: Seems that "explorer" in VS code refers only to files explorer, in our case it might be instance explorer (short version just "explorer") but maybe we should use more generic one "Sidebar"? 🤔 I see following options that could be used:
More examples: one more for xcode (navigator and inspector sounds nice as well) It also got me thinking about this
Seems that Canvas isn't commonly used, so maybe just keep Editor? |
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Jan Potoms <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Co-authored-by: Bharat Kashyap <[email protected]> Signed-off-by: Vytautas Butkus <[email protected]>
Hey @samuelsycamore is this good to be merged? |
@bytasv I'm good to merge this as it is, mainly because this PR has gotten massive and I don't want to add 100 more comments to it! 😅 I would still like to review the "Connecting to datasources" pages, but I can open separate PRs and tackle them one by one once this is wrapped up here. |
Thanks @samuelsycamore ! See what's the easiest way for you to deliver feedback, you can comment on this PR or open new one, lemme know if I can assist somehow |
Partial implementation for #834
Preview: https://deploy-preview-859--mui-toolpad-docs.netlify.app/toolpad/getting-started/overview/
Introduction
andQuickstart
pagesSetup
steps intoQuickstart
as that was basically one paragraph on it's own pageConnecting to data sources
-Connections
,Query
,Fetch
,Function
✅Data binding
section ✅