diff --git a/docs/01-overview.md b/docs/01-overview.md deleted file mode 100644 index 309c736271..0000000000 --- a/docs/01-overview.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Overview ---- - -This section of the documentation contains information that applies to all packages in the Filament ecosystem. - -## Eloquent Models - -All of Filament's database interactions rely on Eloquent. If your application needs to work with a static data source like a plain PHP array, you may find [Sushi](https://github.com/calebporzio/sushi) useful for accessing that data from an Eloquent model. diff --git a/docs/01-quickstart/01-introduction.md b/docs/01-quickstart/01-introduction.md new file mode 100644 index 0000000000..74cb04c494 --- /dev/null +++ b/docs/01-quickstart/01-introduction.md @@ -0,0 +1,3 @@ +--- +title: Introduction to Filament +--- diff --git a/docs/01-quickstart/02-building-an-admin-panel.md b/docs/01-quickstart/02-building-an-admin-panel.md new file mode 100644 index 0000000000..fd240d9890 --- /dev/null +++ b/docs/01-quickstart/02-building-an-admin-panel.md @@ -0,0 +1,3 @@ +--- +title: Building an Admin Panel +--- diff --git a/docs/01-quickstart/03-building-a-saas.md b/docs/01-quickstart/03-building-a-saas.md new file mode 100644 index 0000000000..2e8c619cd6 --- /dev/null +++ b/docs/01-quickstart/03-building-a-saas.md @@ -0,0 +1,3 @@ +--- +title: Building a SaaS +--- diff --git a/docs/01-quickstart/04-adding-a-form-to-a-blade-view.md b/docs/01-quickstart/04-adding-a-form-to-a-blade-view.md new file mode 100644 index 0000000000..8253aebaad --- /dev/null +++ b/docs/01-quickstart/04-adding-a-form-to-a-blade-view.md @@ -0,0 +1,3 @@ +--- +title: Adding a form to a Blade view +--- diff --git a/docs/01-quickstart/05-adding-a-table-to-a-blade-view.md b/docs/01-quickstart/05-adding-a-table-to-a-blade-view.md new file mode 100644 index 0000000000..44f7e2d779 --- /dev/null +++ b/docs/01-quickstart/05-adding-a-table-to-a-blade-view.md @@ -0,0 +1,3 @@ +--- +title: Adding a table to a Blade view +--- diff --git a/docs/01-quickstart/06-adding-modals-to-a-blade-view.md b/docs/01-quickstart/06-adding-modals-to-a-blade-view.md new file mode 100644 index 0000000000..b19e86ff4e --- /dev/null +++ b/docs/01-quickstart/06-adding-modals-to-a-blade-view.md @@ -0,0 +1,3 @@ +--- +title: Adding modals to a Blade view +--- diff --git a/docs/01-quickstart/07-adding-a-read-only-infolist-to-a-blade-view.md b/docs/01-quickstart/07-adding-a-read-only-infolist-to-a-blade-view.md new file mode 100644 index 0000000000..cabdc263b7 --- /dev/null +++ b/docs/01-quickstart/07-adding-a-read-only-infolist-to-a-blade-view.md @@ -0,0 +1,3 @@ +--- +title: Adding a read-only infolist to a Blade view +--- diff --git a/docs/01-quickstart/08-adding-a-chart-to-a-blade-view.md b/docs/01-quickstart/08-adding-a-chart-to-a-blade-view.md new file mode 100644 index 0000000000..e0db4afebb --- /dev/null +++ b/docs/01-quickstart/08-adding-a-chart-to-a-blade-view.md @@ -0,0 +1,3 @@ +--- +title: Adding a chart to a Blade view +--- diff --git a/docs/01-quickstart/09-sending-flash-notifications-in-Livewire.md b/docs/01-quickstart/09-sending-flash-notifications-in-Livewire.md new file mode 100644 index 0000000000..eb0aed16f2 --- /dev/null +++ b/docs/01-quickstart/09-sending-flash-notifications-in-Livewire.md @@ -0,0 +1,3 @@ +--- +title: Sending flash notifications in Livewire +--- diff --git a/docs/02-installation.md b/docs/02-installation.md new file mode 100644 index 0000000000..c497807224 --- /dev/null +++ b/docs/02-installation.md @@ -0,0 +1,4 @@ +--- +title: Installation +--- + diff --git a/docs/02-PACKAGES b/docs/03-PACKAGES similarity index 100% rename from docs/02-PACKAGES rename to docs/03-PACKAGES diff --git a/docs/09-blade-components/01-overview.md b/docs/04-ui/01-overview.md similarity index 100% rename from docs/09-blade-components/01-overview.md rename to docs/04-ui/01-overview.md diff --git a/docs/09-blade-components/02-avatar.md b/docs/04-ui/02-avatar.md similarity index 100% rename from docs/09-blade-components/02-avatar.md rename to docs/04-ui/02-avatar.md diff --git a/docs/09-blade-components/02-badge.md b/docs/04-ui/02-badge.md similarity index 100% rename from docs/09-blade-components/02-badge.md rename to docs/04-ui/02-badge.md diff --git a/docs/09-blade-components/02-breadcrumbs.md b/docs/04-ui/02-breadcrumbs.md similarity index 100% rename from docs/09-blade-components/02-breadcrumbs.md rename to docs/04-ui/02-breadcrumbs.md diff --git a/docs/09-blade-components/02-button.md b/docs/04-ui/02-button.md similarity index 100% rename from docs/09-blade-components/02-button.md rename to docs/04-ui/02-button.md diff --git a/docs/09-blade-components/02-checkbox.md b/docs/04-ui/02-checkbox.md similarity index 100% rename from docs/09-blade-components/02-checkbox.md rename to docs/04-ui/02-checkbox.md diff --git a/docs/09-blade-components/02-dropdown.md b/docs/04-ui/02-dropdown.md similarity index 100% rename from docs/09-blade-components/02-dropdown.md rename to docs/04-ui/02-dropdown.md diff --git a/docs/09-blade-components/02-fieldset.md b/docs/04-ui/02-fieldset.md similarity index 100% rename from docs/09-blade-components/02-fieldset.md rename to docs/04-ui/02-fieldset.md diff --git a/docs/09-blade-components/02-icon-button.md b/docs/04-ui/02-icon-button.md similarity index 100% rename from docs/09-blade-components/02-icon-button.md rename to docs/04-ui/02-icon-button.md diff --git a/docs/09-blade-components/02-input-wrapper.md b/docs/04-ui/02-input-wrapper.md similarity index 100% rename from docs/09-blade-components/02-input-wrapper.md rename to docs/04-ui/02-input-wrapper.md diff --git a/docs/09-blade-components/02-input.md b/docs/04-ui/02-input.md similarity index 100% rename from docs/09-blade-components/02-input.md rename to docs/04-ui/02-input.md diff --git a/docs/09-blade-components/02-link.md b/docs/04-ui/02-link.md similarity index 100% rename from docs/09-blade-components/02-link.md rename to docs/04-ui/02-link.md diff --git a/docs/09-blade-components/02-loading-indicator.md b/docs/04-ui/02-loading-indicator.md similarity index 100% rename from docs/09-blade-components/02-loading-indicator.md rename to docs/04-ui/02-loading-indicator.md diff --git a/docs/09-blade-components/02-modal.md b/docs/04-ui/02-modal.md similarity index 100% rename from docs/09-blade-components/02-modal.md rename to docs/04-ui/02-modal.md diff --git a/docs/09-blade-components/02-pagination.md b/docs/04-ui/02-pagination.md similarity index 100% rename from docs/09-blade-components/02-pagination.md rename to docs/04-ui/02-pagination.md diff --git a/docs/09-blade-components/02-section.md b/docs/04-ui/02-section.md similarity index 100% rename from docs/09-blade-components/02-section.md rename to docs/04-ui/02-section.md diff --git a/docs/09-blade-components/02-select.md b/docs/04-ui/02-select.md similarity index 100% rename from docs/09-blade-components/02-select.md rename to docs/04-ui/02-select.md diff --git a/docs/09-blade-components/02-tabs.md b/docs/04-ui/02-tabs.md similarity index 100% rename from docs/09-blade-components/02-tabs.md rename to docs/04-ui/02-tabs.md diff --git a/docs/05-deployment.md b/docs/05-deployment.md new file mode 100644 index 0000000000..24aa8529da --- /dev/null +++ b/docs/05-deployment.md @@ -0,0 +1,4 @@ +--- +title: Deploying to Production +--- + diff --git a/docs/05-style-customization.md b/docs/06-styling/01-css-hooks.md similarity index 99% rename from docs/05-style-customization.md rename to docs/06-styling/01-css-hooks.md index 522f5351d0..80ef201ef2 100644 --- a/docs/05-style-customization.md +++ b/docs/06-styling/01-css-hooks.md @@ -1,5 +1,5 @@ --- -title: Style customization +title: CSS hooks --- ## Overview diff --git a/docs/04-colors.md b/docs/06-styling/02-colors.md similarity index 100% rename from docs/04-colors.md rename to docs/06-styling/02-colors.md diff --git a/docs/03-icons.md b/docs/06-styling/03-icons.md similarity index 100% rename from docs/03-icons.md rename to docs/06-styling/03-icons.md diff --git a/docs/06-render-hooks.md b/docs/07-advanced/01-render-hooks.md similarity index 100% rename from docs/06-render-hooks.md rename to docs/07-advanced/01-render-hooks.md diff --git a/docs/02-assets.md b/docs/07-advanced/02-assets.md similarity index 100% rename from docs/02-assets.md rename to docs/07-advanced/02-assets.md diff --git a/docs/07-enums.md b/docs/07-advanced/03-enums.md similarity index 100% rename from docs/07-enums.md rename to docs/07-advanced/03-enums.md diff --git a/docs/09-stubs.md b/docs/07-advanced/04-stubs.md similarity index 100% rename from docs/09-stubs.md rename to docs/07-advanced/04-stubs.md diff --git a/docs/09-upgrade-guide.md b/docs/09-upgrade-guide.md new file mode 100644 index 0000000000..78c3d8c7ff --- /dev/null +++ b/docs/09-upgrade-guide.md @@ -0,0 +1,4 @@ +--- +title: Upgrade Guide +--- + diff --git a/docs/10-support.md b/docs/10-about/01-support.md similarity index 100% rename from docs/10-support.md rename to docs/10-about/01-support.md diff --git a/docs/08-contributing.md b/docs/10-about/02-contributing.md similarity index 100% rename from docs/08-contributing.md rename to docs/10-about/02-contributing.md