Skip to content

Commit

Permalink
Updated navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
Aleksandr Movchan committed Jul 19, 2024
1 parent 539c6cb commit e7e2c64
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,23 @@ For developers looking to contribute, make sure to review the [Code Standards](p

If you have any questions or need further assistance, please don't hesitate to reach out to our support team or community forums.

## Development
- [Development Guide](pages/development.md): A guide for developers working on the project, including code structure, dev container setup, and database management.
- [Testing](pages/testing.md): This document covers the testing procedures and guidelines for our project.
- [Deployment Test Cache](pages/deployment_test_cache.md): Information on how deployment test caching works and its configuration.
## Integrations
- [Integrations](pages/integrations.md): Overview of the available predefined deployments like Whisper, vLLM, Hugging Face Transformers, Haystack etc.
- [OpenAI API](pages/openai_api.md): Overview of the OpenAI-compatible Chat Completions API.

## Deployment
- [Docker](pages/docker.md): Instructions for using Docker with Aana SDK.
- [Serve Config Files](pages/serve_config_files.md): Information about [Serve Config Files](https://docs.ray.io/en/latest/serve/production-guide/config.html#serve-config-files) for production deployment, how to build them, and deploy applications using them.
- [Cluster Setup](pages/cluster_setup.md): Instructions for setting up a Ray cluster for deployment.

## Integrations
- [Integrations](pages/integrations.md): Overview of the available predefined deployments like Whisper, vLLM, Hugging Face Transformers, Haystack etc.
- [OpenAI API](pages/openai_api.md): Overview of the OpenAI-compatible Chat Completions API.

## Configuration
- [Settings](pages/settings.md): Documentation on the available settings and configuration options for the project.

## Best Practices
- [Code Standards](pages/code_standards.md): Learn about our coding standards and best practices for contributing to the project.

## Development
- [Development Guide](pages/development.md): A guide for developers working on the project, including code structure, dev container setup, and database management.
- [Testing](pages/testing.md): This document covers the testing procedures and guidelines for our project.
- [Deployment Test Cache](pages/deployment_test_cache.md): Information on how deployment test caching works and its configuration.

1 change: 1 addition & 0 deletions docs/pages/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Settings

Here are the environment variables that can be used to configure the Aaana SDK:

- TMP_DATA_DIR: The directory to store temporary data. Default: `/tmp/aana`.
- NUM_WORKERS: The number of request workers. Default: `2`.
- DB_CONFIG: The database configuration in the format `{"datastore_type": "sqlite", "datastore_config": {"path": "/path/to/sqlite.db"}}`. Currently only SQLite and PostgreSQL are supported. Default: `{"datastore_type": "sqlite", "datastore_config": {"path": "/var/lib/aana_data"}}`.
Expand Down
17 changes: 17 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,23 @@ extra:
# Page tree
nav:
- Home: index.md
- Getting Started:
- Tutorial: pages/tutorial.md
- Integrations:
- Overview: pages/integrations.md
- OpenAI API: pages/openai_api.md
- Deployment:
- Docker: pages/docker.md
- Serve Config Files: pages/serve_config_files.md
- Cluster Setup: pages/cluster_setup.md
- Configuration:
- Settings: pages/settings.md
- Best Practices:
- Code Standards: pages/code_standards.md
- Development:
- Development Guide: pages/development.md
- Testing: pages/testing.md
- Deployment Test Cache: pages/deployment_test_cache.md
- Reference (Code API):
- reference/aana_api.md
- reference/aana_deployments.md

0 comments on commit e7e2c64

Please sign in to comment.