Skip to content

Commit

Permalink
docs: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Kreyu committed Jan 21, 2024
1 parent 4373e3c commit c5fdfda
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 15 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,19 @@ Streamlines the creation process of the data tables in Symfony applications.
## Features

- [Type classes](https://data-table-bundle.swroblewski.pl/features/type-classes) for a class-based configuration, similar to [Symfony Forms](https://symfony.com/doc/current/forms.html)
- [Paginating](https://data-table-bundle.swroblewski.pl/features/pagination), [sorting](https://data-table-bundle.swroblewski.pl/features/sorting) and [filtering](https://data-table-bundle.swroblewski.pl/features/filtering) - classic triforce of the data tables
- [Personalization](https://data-table-bundle.swroblewski.pl/features/personalization) where the user decides the order and visibility of columns
- [Persistence](https://data-table-bundle.swroblewski.pl/features/persistence) to save user-applied pagination, sorting, filters and personalization
- [Exporting](https://data-table-bundle.swroblewski.pl/features/exporting) with or without applied pagination, personalization and filters
- [Theming](https://data-table-bundle.swroblewski.pl/features/theming) of every part of the bundle
- [Data source agnostic](https://data-table-bundle.swroblewski.pl/features/proxy-queries) with Doctrine ORM supported out of the box
- [Integration with Symfony UX Turbo](https://data-table-bundle.swroblewski.pl/features/symfony-ux-turbo) for asynchronicit
- [Type classes](https://data-table-bundle.swroblewski.pl/docs/introduction#similarity-to-form-component) for a class-based configuration, like in a Symfony Form component
- [Sorting](https://data-table-bundle.swroblewski.pl/docs/features/sorting), [filtering](https://data-table-bundle.swroblewski.pl/docs/features/filtering) and [pagination](https://data-table-bundle.swroblewski.pl/docs/features/pagination) - classic triforce of the data tables
- [Personalization](https://data-table-bundle.swroblewski.pl/docs/features/features/personalization) where the user decides the order and visibility of columns
- [Persistence](https://data-table-bundle.swroblewski.pl/docs/features/persistence) to save applied data (e.g. filters) between requests
- [Exporting](https://data-table-bundle.swroblewski.pl/docs/features/exporting) with or without applied pagination, filters and personalization
- [Theming](https://data-table-bundle.swroblewski.pl/docs/features/theming) of every part of the bundle using Twig
- [Data source agnostic](https://data-table-bundle.swroblewski.pl/docs/features/extensibility) with Doctrine ORM supported out of the box
- [Asynchronicity](https://data-table-bundle.swroblewski.pl/docs/features/asynchronicity) thanks to integration with Hotwire Turbo

## Documentation

Check out the [official documentation](https://data-table-bundle.swroblewski.pl).

If there's a problem with the domain, see [documentation on Netlify](https://incomparable-halva-a2f805.netlify.app/).
Alternatively, see `docs` directory.

## License

The MIT License (MIT). Please see [license file](LICENSE) for more information.
6 changes: 3 additions & 3 deletions docs/src/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Just want to try it out? Skip to the [installation](installation.md).
## Features

- [Type classes](#similarity-to-form-component) for a class-based configuration, like in a Symfony Form component
- [Sorting](features/sorting.md), [filtering](features/filtering.md) and [pagination](features/pagination.md) - triforce of the data tables
- [Sorting](features/sorting.md), [filtering](features/filtering.md) and [pagination](features/pagination.md) - classic triforce of the data tables
- [Personalization](features/personalization.md) where the user decides the order and visibility of columns
- [Persistence](features/persistence.md) to save applied data (e.g. filters) between requests
- [Exporting](features/exporting.md) with or without applied pagination, filters and personalization
- [Theming](features/theming.md) of every part of the bundle using Twig
- [Data source agnostic](features/extensibility.md) with optional Doctrine ORM integration bundle
- [Integration with Hotwire Turbo](features/asynchronicity.md) for asynchronicity
- [Data source agnostic](features/extensibility.md) with Doctrine ORM supported out of the box
- [Asynchronicity](features/asynchronicity.md) thanks to integration with Hotwire Turbo

## Use cases

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ features:
details: Every template part of the bundle is customizable using Twig
- title: Data source agnostic
details: With Doctrine ORM supported out of the box
- title: Asynchronous
- title: Asynchronicity
details: Thanks to integration with Hotwire Turbo, data tables are asynchronous
---

Expand Down

0 comments on commit c5fdfda

Please sign in to comment.