search

mui / toolpad

Toolpad: Full stack components and low-code builder for dashboards and internal apps.
https://mui.com/toolpad/
MIT License
964 stars 244 forks source link

[docs] Restructure #2052

Closed prakhargupta1 closed 1 year ago

prakhargupta1 commented 1 year ago

As discussed, below is the new docs structure.

Getting Started

A quick brief on Toolpad

  1. Overview
  2. Installation
  3. Build your first app (installation section to be linked)
  4. Examples (list of examples from GitHub)
  5. Roadmap

Concepts

It will have the 3 existing sections: Connecting to DS, Building UI, Data binding

  1. Building UI (current canvas and component library section + page shell parameter)
  2. Connecting to data (Queries: HTTP requests, Custom functions, Manually calling queries)
  3. Managing state (current data binding section + page variables)
  4. Deployment
  5. Custom components
  6. Theming (Move component styling here)

How-to guides

Narrow use cases, to solve immediate pains that come while building a Toolpad app. Eg:

  1. Connect to MySQL/Postgresql
  2. Delete a data grid row
  3. Create custom columns (current data grid section)
  4. Deploy to render.com
  5. Embed applications
  6. Add basic auth

Tutorials

How to build e2e app.

(I think we can invest on this later, as I would prefer these to be video tutorials)

Reference

  1. File schema
  2. Javascript API
  3. Components
  4. Configuration (env vars to configure Toolpad itself with)
Janpot commented 1 year ago

@bharatkashyap I'll restructure the reference pages in https://github.com/mui/mui-toolpad/pull/2001