refactor guide section, table instance guide

KevinVandy · KevinVandy · commit dc208d463fe5 · 2024-01-03T23:38:40.000-06:00
diff --git a/docs/api/core/header.md b/docs/api/core/header.md
@@ -38,15 +38,15 @@ The depth of the header, zero-indexed based.
 column: Column<TData>
 ```
 
-The header's associated [Column](./column.md) object
+The header's associated [Column](./column) object
 
 ### `headerGroup`
 
 ```tsx
 headerGroup: HeaderGroup<TData>
 ```
 
-The header's associated [HeaderGroup](./header-group.md) object
+The header's associated [HeaderGroup](./header-group) object
 
 ### `subHeaders`
 
diff --git a/docs/api/core/row.md b/docs/api/core/row.md
@@ -120,4 +120,4 @@ An array of the original subRows as returned by the `options.getSubRows` option.
 type getAllCells = () => Cell<TData>[]
 ```
 
-Returns all of the [Cells](./cell.md) for the row.
+Returns all of the [Cells](./cell) for the row.
diff --git a/docs/config.json b/docs/config.json
@@ -49,13 +49,17 @@
           "label": "Migrating to V8",
           "to": "guide/migrating"
         },
+        {
+          "label": "Tables (Getting Started)",
+          "to": "guide/tables"
+        },
         {
           "label": "Column Defs",
           "to": "guide/column-defs"
         },
         {
-          "label": "Tables",
-          "to": "guide/tables"
+          "label": "Rows Models",
+          "to": "guide/row-models"
         },
         {
           "label": "Rows",
@@ -77,6 +81,10 @@
           "label": "Column Ordering",
           "to": "guide/column-ordering"
         },
+        {
+          "label": "Column Pinning",
+          "to": "guide/column-pinning"
+        },
         {
           "label": "Column Sizing",
           "to": "guide/column-sizing"
@@ -86,8 +94,20 @@
           "to": "guide/column-visibility"
         },
         {
-          "label": "Filters",
-          "to": "guide/filters"
+          "label": "Column Filtering",
+          "to": "guide/column-filtering"
+        },
+        {
+          "label": "Global Filtering",
+          "to": "guide/global-filtering"
+        },
+        {
+          "label": "Fuzzy Filtering",
+          "to": "guide/fuzzy-filtering"
+        },
+        {
+          "label": "Faceted Values",
+          "to": "guide/faceted-values"
         },
         {
           "label": "Sorting",
@@ -106,8 +126,8 @@
           "to": "guide/pagination"
         },
         {
-          "label": "Pinning",
-          "to": "guide/pinning"
+          "label": "Row Pinning",
+          "to": "guide/row-pinning"
         },
         {
           "label": "Row Selection",
diff --git a/docs/guide/column-filtering.md b/docs/guide/column-filtering.md
@@ -0,0 +1,24 @@
+---
+title: Column Filtering
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [filters](../examples/react/filters) (includes faceting)
+- [editable-data](../examples/react/editable-data)
+- [expanding](../examples/react/expanding)
+- [grouping](../examples/react/grouping)
+- [pagination](../examples/react/pagination)
+- [row-selection](../examples/react/row-selection)
+
+## API
+
+[Filters API](../api/features/filters)
+
+## Column Filtering Guide
+
+Filtering comes in 2 flavors: Column Filtering and Global Filtering.
+
+This guide will focus on column filtering, which is a filter that is applied to a single column's accessor value.
diff --git a/docs/guide/column-ordering.md b/docs/guide/column-ordering.md
@@ -12,7 +12,7 @@ Want to skip to the implementation? Check out these examples:
 
 [Column Ordering API](../api/features/column-ordering)
 
-## Overview
+## Column Ordering Guide
 
 There are 3 table features that can reorder columns, which happen in the following order:
 
diff --git a/docs/guide/column-pinning.md b/docs/guide/column-pinning.md
@@ -0,0 +1,22 @@
+---
+title: Column Pinning
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [column-pinning](../examples/react/column-pinning)
+- [row-pinning](../examples/react/row-pinning)
+
+## API
+
+[Pinning API](../api/features/pinning)
+
+## Column Pinning Guide
+
+There are 3 table features that can reorder columns, which happen in the following order:
+
+1. **Column Pinning** - If pinning, columns are split into left, center (unpinned), and right pinned columns.
+2. Manual [Column Ordering](../guide/column-ordering) - A manually specified column order is applied.
+3. [Grouping](../guide/grouping) - If grouping is enabled, a grouping state is active, and `tableOptions.columnGroupingMode` is set to `'reorder' | 'remove'`, then the grouped columns are reordered to the start of the column flow.
diff --git a/docs/guide/column-sizing.md b/docs/guide/column-sizing.md
@@ -13,7 +13,7 @@ Want to skip to the implementation? Check out these examples:
 
 [Column Sizing API](../api/features/column-sizing)
 
-## Guide
+## Column Sizing Guide
 
 The column sizing feature allows you to optionally specify the width of each column including min and max widths. It also allows you and your users the ability to dynamically change the width of all columns at will, eg. by dragging the column headers.
 
diff --git a/docs/guide/column-visibility.md b/docs/guide/column-visibility.md
@@ -12,3 +12,5 @@ Want to skip to the implementation? Check out these examples:
 ## API
 
 [Column Visibility API](../api/features/column-visibility)
+
+## Column Visibility Guide
diff --git a/docs/guide/expanding.md b/docs/guide/expanding.md
@@ -12,3 +12,5 @@ Want to skip to the implementation? Check out these examples:
 ## API
 
 [Expanding API](../api/features/expanding)
+
+## Expanding Feature Guide
diff --git a/docs/guide/faceted-values.md b/docs/guide/faceted-values.md
@@ -0,0 +1,15 @@
+---
+title: Faceted Values
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [filters](../examples/react/filters) (includes faceting)
+
+## API
+
+[Filters API](../api/features/filters)
+
+## Faceted Values Guide
diff --git a/docs/guide/features.md b/docs/guide/features.md
@@ -4,13 +4,14 @@ title: Features
 
 TanStack Table comes with many features, each with their own associated options and API:
 
-- [Column Visibility](./guide/column-visibility)
 - [Column Ordering](./guide/column-ordering)
 - [Column Pinning](./guide/column-pinning)
 - [Column Sizing](./guide/column-sizing)
+- [Column Visibility](./guide/column-visibility)
+- [Expanding](./guide/expanding)
 - [Filters](./guide/filters)
-- [Sorting](./guide/sorting)
 - [Grouping](./guide/grouping)
-- [Expanding](./guide/expanding)
-- [Row Selection](./guide/row-selection)
 - [Pagination](./guide/pagination)
+- [Row Pinning](./guide/row-pinning)
+- [Row Selection](./guide/row-selection)
+- [Sorting](./guide/sorting)
diff --git a/docs/guide/filters.md b/docs/guide/filters.md
@@ -2,28 +2,11 @@
 title: Filters
 ---
 
-## Examples
+<!-- Deprecated -->
 
-Want to skip to the implementation? Check out these examples:
+The filter guides are now split into multiple guides:
 
-- [filters](../examples/react/filters) (includes faceting)
-- [editable-data](../examples/react/editable-data)
-- [expanding](../examples/react/expanding)
-- [grouping](../examples/react/grouping)
-- [pagination](../examples/react/pagination)
-- [row-selection](../examples/react/row-selection)
-
-## API
-
-[Filters API](../api/features/filters)
-
-## Overview
-
-Filters come in two flavors:
-
-- Column filters
-  - A filter that is applied to a single column's accessor value.
-  - Stored in the `state.columnFilters` array as an object containing the columnId and the filter value.
-- Global filters
-  - A single filter value that is applied to all or some of columns' accessor values.
-  - Stored in the `state.globalFilter` array as any value, usually a string.
+- [Column Filtering](./column-filtering)
+- [Global Filtering](./global-filtering)
+- [Fuzzy Filtering](./fuzzy-filtering)
+- [Faceted Values](./faceted-values)
diff --git a/docs/guide/fuzzy-filtering.md b/docs/guide/fuzzy-filtering.md
@@ -0,0 +1,16 @@
+---
+title: Fuzzy Filtering
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [filters](../examples/react/filters)
+
+## API
+
+[Filters API](../api/features/filters)
+
+## Fuzzy Filtering Guide
+
diff --git a/docs/guide/global-filtering.md b/docs/guide/global-filtering.md
@@ -0,0 +1,19 @@
+---
+title: Global Filtering
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [filters](../examples/react/filters) (includes faceting)
+
+## API
+
+[Filters API](../api/features/filters)
+
+## Overview
+
+Filtering comes in 2 flavors: Column Filtering and Global Filtering.
+
+This guide will focus on global filtering, which is a filter that is applied across all columns.
diff --git a/docs/guide/grouping.md b/docs/guide/grouping.md
@@ -12,7 +12,7 @@ Want to skip to the implementation? Check out these examples:
 
 [Grouping API](../api/features/grouping)
 
-## Overview
+## Grouping Guide
 
 There are 3 table features that can reorder columns, which happen in the following order:
 
diff --git a/docs/guide/headers.md b/docs/guide/headers.md
@@ -5,3 +5,5 @@ title: Headers
 ## API
 
 [Header API](../api/core/header)
+
+## Headers Guide
diff --git a/docs/guide/pagination.md b/docs/guide/pagination.md
@@ -17,3 +17,5 @@ Want to skip to the implementation? Check out these examples:
 ## API
 
 [Pagination API](../api/features/pagination)
+
+## Pagination Guide
diff --git a/docs/guide/pinning.md b/docs/guide/pinning.md
@@ -2,26 +2,9 @@
 title: Pinning
 ---
 
-## Examples
+<!-- Deprecated  -->
 
-Want to skip to the implementation? Check out these examples:
+Pinning is split into 2 different feature guides:
 
-- [column-pinning](../examples/react/column-pinning)
-- [row-pinning](../examples/react/row-pinning)
-
-## API
-
-[Pinning API](../api/features/pinning)
-
-## Overview
-
-There are 3 table features that can reorder columns, which happen in the following order:
-
-1. **Column Pinning** - If pinning, columns are split into left, center (unpinned), and right pinned columns.
-2. Manual [Column Ordering](../guide/column-ordering) - A manually specified column order is applied.
-3. [Grouping](../guide/grouping) - If grouping is enabled, a grouping state is active, and `tableOptions.columnGroupingMode` is set to `'reorder' | 'remove'`, then the grouped columns are reordered to the start of the column flow.
-
-There are 2 table features that can reorder rows, which happen in the following order:
-
-1. **Row Pinning** - If pinning, rows are split into top, center (unpinned), and bottom pinned rows.
-2. [Sorting](../guide/sorting)
+- [Column Pinning](./column-pinning)
+- [Row Pinning](./row-pinning)
diff --git a/docs/guide/row-models.md b/docs/guide/row-models.md
@@ -0,0 +1,3 @@
+---
+title: Row Models
+---
diff --git a/docs/guide/row-pinning.md b/docs/guide/row-pinning.md
@@ -0,0 +1,20 @@
+---
+title: Row Pinning
+---
+
+## Examples
+
+Want to skip to the implementation? Check out these examples:
+
+- [row-pinning](../examples/react/row-pinning)
+
+## API
+
+[Pinning API](../api/features/pinning)
+
+## Row Pinning Guide
+
+There are 2 table features that can reorder rows, which happen in the following order:
+
+1. **Row Pinning** - If pinning, rows are split into top, center (unpinned), and bottom pinned rows.
+2. [Sorting](../guide/sorting)
diff --git a/docs/guide/row-selection.md b/docs/guide/row-selection.md
@@ -14,7 +14,7 @@ Want to skip to the implementation? Check out these examples:
 
 [Row Selection API](../api/features/row-selection)
 
-## Guide
+## Row Selection Guide
 
 The row selection feature keeps track of which rows are selected and allows you to toggle the selection of rows in a myriad of ways. Let's take a look at some common use cases.
 
diff --git a/docs/guide/sorting.md b/docs/guide/sorting.md
@@ -12,3 +12,5 @@ Want to skip to the implementation? Check out these examples:
 ## API
 
 [Sorting API](../api/features/sorting)
+
+## Sorting Guide
diff --git a/docs/guide/tables.md b/docs/guide/tables.md
diff --git a/docs/guide/virtualization.md b/docs/guide/virtualization.md
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
