Skip to content

Commit 6ff4d28

Browse files
authored
chore: update documentation geospatial (#60)
* feat: add geospatial features and datasets for Buenos Aires - Introduced geospatial types and interfaces in `types.ts` for managing geospatial data. - Created a new dataset file `geospatialDatasets.ts` containing restaurants, cafes, parks, and hotels in Buenos Aires with relevant attributes. - Integrated a new `GeospatialPlayground` component in the theme for interactive geospatial data visualization. - Updated the geospatial operators guide to include an interactive playground section. - Added Leaflet and Vue-Leaflet dependencies for map functionalities. * feat(playground): add example filtering scenarios and components - Created a new file for example filtering scenarios with various use cases. - Added Playground components for better organization and modularity. - Introduced types for examples and datasets to enhance type safety. - Updated the main theme index to include the new Playground components. - Added Vue plugin for Vite to support Vue components in the project. - Updated package dependencies to include the necessary Vue plugin. - Configured Vitest to include tests for the new Playground components. * feat: Add Vue integration documentation - Introduced a new guide for using filter with Vue 3, covering installation, available composables, and usage examples. - Removed outdated Getting Started and Installation guides to streamline documentation. - Added detailed operator documentation, including Array and Comparison operators. - Created an Operators Reference page for quick navigation and comprehensive operator details. - Introduced a Recipes section with practical examples for common filtering scenarios. * feat(geospatial): store zoom level on map zoom change and update label display logic
1 parent 1e2b98c commit 6ff4d28

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+5878
-4935
lines changed

docs/.vitepress/config.ts

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ export default defineConfig({
2121
logo: '/logo.svg',
2222

2323
nav: [
24-
{ text: 'Guide', link: '/guide/getting-started', activeMatch: '/guide/' },
24+
{ text: 'Guide', link: '/guide/quick-start', activeMatch: '/guide/' },
25+
{ text: 'Operators', link: '/operators/', activeMatch: '/operators/' },
26+
{ text: 'Recipes', link: '/recipes/', activeMatch: '/recipes/' },
2527
{ text: 'Playground', link: '/playground/', activeMatch: '/playground/' },
26-
{ text: 'Frontend', link: '/frontend/overview', activeMatch: '/frontend/' },
27-
{ text: 'Backend', link: '/backend/express', activeMatch: '/backend/' },
28+
{ text: 'Frameworks', link: '/frameworks/', activeMatch: '/frameworks/' },
2829
{ text: 'API', link: '/api/reference', activeMatch: '/api/' },
2930
{ text: 'Examples', link: '/examples/basic', activeMatch: '/examples/' },
3031
{
@@ -53,11 +54,8 @@ export default defineConfig({
5354
text: 'Getting Started',
5455
collapsed: false,
5556
items: [
56-
{ text: 'Introduction', link: '/guide/getting-started' },
57-
{ text: 'Installation', link: '/guide/installation' },
5857
{ text: 'Quick Start', link: '/guide/quick-start' },
5958
{ text: 'Basic Filtering', link: '/guide/basic-filtering' },
60-
{ text: 'Migration Guide v5.4', link: '/guide/migration-v2' },
6159
],
6260
},
6361
{
@@ -106,43 +104,62 @@ export default defineConfig({
106104
{ text: 'Type System', link: '/advanced/type-system' },
107105
{ text: 'Performance Benchmarks', link: '/advanced/performance-benchmarks' },
108106
{ text: 'Migration Guide', link: '/advanced/migration' },
109-
{ text: 'Complete Documentation', link: '/advanced/complete-documentation' },
110107
],
111108
},
112109
],
113-
'/frontend/': [
110+
'/frameworks/': [
114111
{
115112
text: 'Framework Integrations',
116113
collapsed: false,
117114
items: [
118-
{ text: 'Overview', link: '/frontend/overview' },
119-
{ text: 'React', link: '/frontend/react' },
120-
{ text: 'Vue', link: '/frontend/vue' },
121-
{ text: 'Svelte', link: '/frontend/svelte' },
115+
{ text: 'Overview', link: '/frameworks/' },
116+
{ text: 'React', link: '/frameworks/react' },
117+
{ text: 'Vue', link: '/frameworks/vue' },
118+
{ text: 'Svelte', link: '/frameworks/svelte' },
122119
],
123120
},
124121
{
125122
text: 'SSR Frameworks',
126123
collapsed: false,
127124
items: [
128-
{ text: 'Next.js', link: '/frontend/nextjs' },
129-
{ text: 'Nuxt', link: '/frontend/nuxt' },
130-
{ text: 'SvelteKit', link: '/frontend/sveltekit' },
125+
{ text: 'Next.js', link: '/frameworks/nextjs' },
126+
{ text: 'Nuxt', link: '/frameworks/nuxt' },
127+
{ text: 'SvelteKit', link: '/frameworks/sveltekit' },
128+
],
129+
},
130+
{
131+
text: 'Backend Frameworks',
132+
collapsed: false,
133+
items: [
134+
{ text: 'Node.js', link: '/frameworks/nodejs' },
135+
{ text: 'Express.js', link: '/frameworks/express' },
136+
{ text: 'NestJS', link: '/frameworks/nestjs' },
137+
{ text: 'Deno', link: '/frameworks/deno' },
131138
],
132139
},
133140
],
134-
'/backend/': [
141+
'/operators/': [
135142
{
136-
text: 'Backend Integration',
143+
text: 'Operator Reference',
137144
collapsed: false,
138145
items: [
139-
{ text: 'Node.js', link: '/backend/nodejs' },
140-
{ text: 'Express.js', link: '/backend/express' },
141-
{ text: 'NestJS', link: '/backend/nestjs' },
142-
{ text: 'Deno', link: '/backend/deno' },
146+
{ text: 'All Operators', link: '/operators/' },
147+
{ text: 'Comparison', link: '/operators/comparison' },
148+
{ text: 'Array', link: '/operators/array' },
149+
{ text: 'String', link: '/guide/operators#string-operators' },
150+
{ text: 'Logical', link: '/guide/logical-operators' },
151+
{ text: 'Geospatial', link: '/guide/geospatial-operators' },
152+
{ text: 'DateTime', link: '/guide/datetime-operators' },
143153
],
144154
},
145155
],
156+
'/recipes/': [
157+
{
158+
text: 'Recipes',
159+
collapsed: false,
160+
items: [{ text: 'All Recipes', link: '/recipes/' }],
161+
},
162+
],
146163
'/api/': [
147164
{
148165
text: 'API Reference',

0 commit comments

Comments
 (0)