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

[docs] Toolpad docs part 1 #859

Merged
merged 128 commits into from
Sep 15, 2022
Merged

[docs] Toolpad docs part 1 #859

merged 128 commits into from
Sep 15, 2022

Conversation

bytasv
Copy link
Contributor

@bytasv bytasv commented Aug 26, 2022

Partial implementation for #834
Preview: https://deploy-preview-859--mui-toolpad-docs.netlify.app/toolpad/getting-started/overview/

  1. Started working on docs according to notion page structure - got Introduction and Quickstart pages
  2. Merged Setup steps into Quickstart as that was basically one paragraph on it's own page
  3. Added step-by-step guide both to build first app and to deploy it
  4. Connecting to data sources - Connections, Query, Fetch, Function
  5. Data binding section ✅

@bytasv bytasv added the docs Improvements or additions to the documentation label Aug 26, 2022
@bytasv bytasv self-assigned this Aug 26, 2022
@render
Copy link

render bot commented Aug 26, 2022

@oliviertassinari oliviertassinari requested a deployment to toolpad-documentation - toolpad-db PR #859 August 26, 2022 11:14 — with Render Abandoned
@oliviertassinari oliviertassinari changed the title [Docs] Add intro and quickstart docs [docs] Add intro and quickstart docs Aug 27, 2022
docs/data/pages.ts Outdated Show resolved Hide resolved
Signed-off-by: Siriwat K <[email protected]>
docs/data/pages.ts Outdated Show resolved Hide resolved
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 29, 2022
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 31, 2022
Copy link
Member

@oliviertassinari oliviertassinari left a 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?

docs/data/toolpad/connecting-to-data-sources/fetch.md Outdated Show resolved Hide resolved
docs/data/toolpad/getting-started/introduction.md Outdated Show resolved Hide resolved
docs/data/toolpad/data-binding.md Outdated Show resolved Hide resolved
docs/data/toolpad/connecting-to-data-sources/fetch.md Outdated Show resolved Hide resolved
bytasv and others added 4 commits September 1, 2022 09:53
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]>
@prakhargupta1
Copy link
Member

prakhargupta1 commented Sep 1, 2022

A couple of suggestions for consideration. Should we replace:

  1. Toolpad app with Toolpad
  2. Component's library with Component drawer
  3. Application editor with Canvas
  4. Properties editor with Properties pane or right pane
  5. Instance editor with left pane

based on:
-single word > two words
-Along with the name, if we could help users visualize then it would be better

@Janpot
Copy link
Member

Janpot commented Sep 1, 2022

  1. Instance editor with left pane

alternatively:

  • project hierarchy
  • explorer (They use this in vscode)
  • navigation pane
  • outliner (blender)

@bytasv
Copy link
Contributor Author

bytasv commented Sep 1, 2022

@oliviertassinari

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.

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?

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?

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...


@prakhargupta1

Component's library with Component drawer

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:

image

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:

  1. Left pane and Right pane
  2. Explorer (left) and Properties (right)
  3. Left sidebar and Right sidebar (this is maybe bit more explicit as being on the "side" compared to pane 🤔 )

More examples:

xcode:
image

one more for xcode (navigator and inspector sounds nice as well)
image

It also got me thinking about this

Application editor with Canvas

Seems that Canvas isn't commonly used, so maybe just keep Editor?

@bytasv
Copy link
Contributor Author

bytasv commented Sep 15, 2022

Hey @samuelsycamore is this good to be merged?

@samuelsycamore
Copy link
Member

@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.

@bytasv bytasv merged commit 6a7e48e into master Sep 15, 2022
@bytasv bytasv deleted the toolpad-documentation branch September 15, 2022 16:44
@bytasv
Copy link
Contributor Author

bytasv commented Sep 15, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants