Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 5 additions & 25 deletions documentation/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ sidebar_position: 2

# Installation

## Adding the Dependency

To start using QuantaDB, add the dependency to your `pubspec.yaml` file:

```yaml
Expand Down Expand Up @@ -37,27 +35,10 @@ QuantaDB works on all platforms supported by Dart/Flutter:

- ✅ Android
- ✅ iOS
- ✅ macOS
- ✅ Windows
- ✅ Linux
- ✅ Web (with IndexedDB adapter)

## Build Configuration

Add the following to your `build.yaml` file to configure code generation:

```yaml
targets:
$default:
builders:
quanta_db:
options:
# Enable debug logging
debug: false

# Custom output directory (optional)
output_dir: lib/generated
```
- 🏗️ macOS
- 🏗️ Windows
- 🏗️ Linux
- 🏗️ Web (with IndexedDB adapter)

## Development Dependencies

Expand All @@ -66,7 +47,6 @@ For development, you might want to add these optional dependencies:
```yaml
dev_dependencies:
build_runner: ^2.4.0
quanta_db_generator: ^0.0.5
```

## Code Generation
Expand Down Expand Up @@ -128,6 +108,6 @@ If you encounter any issues:

## Next Steps

- Read the [Getting Started](getting-started) guide
- Read the [Getting Started Guide](intro)
- Check out the [Examples](https://github.com/champ96k/quanta_db/tree/master/example) directory
- Review the [API Reference](https://quantadb.netlify.app/)
10 changes: 5 additions & 5 deletions documentation/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

This section covers the basic usage of QuantaDB, from simple key-value operations to advanced features.

For more detailed information about specific features, check out our [Features](features) section.
For more detailed information about specific features, check out the individual feature pages in the sidebar (e.g., [Type Safety](features/type-safety), [Data Security](features/data-security), [High Performance](features/high-performance)).

## Basic Operations

Expand Down Expand Up @@ -206,7 +206,7 @@ subscription.cancel();

## Next Steps

- Read about [Advanced Features](features/)
- Check out [Code Examples](../code_examples)
- Review [Performance Tips](features/high-performance.md)
- Learn about [Data Security](features/data-security.md)
- Check out [Code Examples](https://github.com/champ96k/quanta_db/tree/master/example)
- Review [Performance Tips](features/high-performance)
- Learn about [Data Security](features/data-security)
- Explore [Type Safety](features/type-safety)
17 changes: 17 additions & 0 deletions documentation/netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[build]
base = "documentation"
command = "npm run build"
publish = "build"

[build.environment]
NODE_VERSION = "18"

[[redirects]]
from = "/*"
to = "/index.html"
status = 200

[build.processing]
skip_processing = false
[build.processing.html]
pretty_urls = true
Loading