diff --git a/README.md b/README.md index 7a9b9593e9..e35c418af8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ storyteller-rust ================ -Our Rust monorepo, which serves both our API surface area and our downloadable client applications. +Our Artcraft monorepo, which serves our desktop application, backend infrastructure, and more. ``` ."-,.__ @@ -45,5 +45,6 @@ Our Rust monorepo, which serves both our API surface area and our downloadable c / ,"'"\,' `/ `-.|" ``` -- [documentation](./_develop/docs) -- [tools, misc](./_develop) +- [developer documentation](./_docs) +- [server API reference](https://storyteller-docs.netlify.app/) +- [tools, scripts, misc](./script) diff --git a/_docs/code_conventions.md b/_docs/code_conventions.md new file mode 100644 index 0000000000..721472d640 --- /dev/null +++ b/_docs/code_conventions.md @@ -0,0 +1,26 @@ +Code Conventions +================ + +We use three languages at Artcraft: Rust, TypeScript, and Python. + +## Rust style guide + +We deviate from the official Rust style guide in a few places: + +- We use two spaces for indentation instead of four. +- We typically keep one function or type definition per file, though this isn't a steadfast rule. +- We use a Cargo workspace to share code within our monorepo. + +### Rust Preferred Libraries + +We use the following Rust libraries, though we are open to migrating to alternatives: + +- `actix-web` for our HTTP web server +- `reqwest` for HTTP client requests +- `sqlx` for SQL database operations +- `tokio` for asynchronous programming + +## TypeScript style guide + +- We use two spaces for indentation instead of four. +- We use `nx` for monorepo management diff --git a/_develop/docs/local_development/general_setup.md b/_docs/local_development_setup_guide.md similarity index 99% rename from _develop/docs/local_development/general_setup.md rename to _docs/local_development_setup_guide.md index 6464f1aae3..37ecef5cc9 100644 --- a/_develop/docs/local_development/general_setup.md +++ b/_docs/local_development_setup_guide.md @@ -1,5 +1,5 @@ -FakeYou Development Setup (bare metal) -====================================== +Local Development Setup Guide (for bare metal) +============================================== This document describes how to run the FakeYou infrastructure on your development machine's bare metal (no containers). diff --git a/_develop/docs/README.md b/_docs/old/old_docs/README.md similarity index 100% rename from _develop/docs/README.md rename to _docs/old/old_docs/README.md diff --git a/_develop/docs/cheat_sheet/actix.md b/_docs/old/old_docs/cheat_sheet/actix.md similarity index 100% rename from _develop/docs/cheat_sheet/actix.md rename to _docs/old/old_docs/cheat_sheet/actix.md diff --git a/_develop/docs/cheat_sheet/migrations.md b/_docs/old/old_docs/cheat_sheet/migrations.md similarity index 100% rename from _develop/docs/cheat_sheet/migrations.md rename to _docs/old/old_docs/cheat_sheet/migrations.md diff --git a/_develop/docs/local_development/local_development_k8s.md b/_docs/old/old_docs/local_development/local_development_k8s.md similarity index 100% rename from _develop/docs/local_development/local_development_k8s.md rename to _docs/old/old_docs/local_development/local_development_k8s.md diff --git a/_develop/docs/local_development/local_development_nginx_proxy.md b/_docs/old/old_docs/local_development/local_development_nginx_proxy.md similarity index 100% rename from _develop/docs/local_development/local_development_nginx_proxy.md rename to _docs/old/old_docs/local_development/local_development_nginx_proxy.md diff --git a/_develop/docs/production/production_builds_and_deployment.md b/_docs/old/old_docs/production/production_builds_and_deployment.md similarity index 100% rename from _develop/docs/production/production_builds_and_deployment.md rename to _docs/old/old_docs/production/production_builds_and_deployment.md diff --git a/_develop/docs/production/production_database.md b/_docs/old/old_docs/production/production_database.md similarity index 100% rename from _develop/docs/production/production_database.md rename to _docs/old/old_docs/production/production_database.md diff --git a/_develop/docs/schema/database_schema.md b/_docs/old/old_docs/schema/database_schema.md similarity index 100% rename from _develop/docs/schema/database_schema.md rename to _docs/old/old_docs/schema/database_schema.md diff --git a/_develop/docs/schema/redis_schema.md b/_docs/old/old_docs/schema/redis_schema.md similarity index 100% rename from _develop/docs/schema/redis_schema.md rename to _docs/old/old_docs/schema/redis_schema.md diff --git a/_develop/localdev/Dockerfile b/_docs/old/old_localdev_setup/Dockerfile similarity index 100% rename from _develop/localdev/Dockerfile rename to _docs/old/old_localdev_setup/Dockerfile diff --git a/_develop/localdev/kubernetes.yml b/_docs/old/old_localdev_setup/kubernetes.yml similarity index 100% rename from _develop/localdev/kubernetes.yml rename to _docs/old/old_localdev_setup/kubernetes.yml diff --git a/_develop/localdev/nginx-http-config/storyteller b/_docs/old/old_localdev_setup/nginx-http-config/storyteller similarity index 100% rename from _develop/localdev/nginx-http-config/storyteller rename to _docs/old/old_localdev_setup/nginx-http-config/storyteller diff --git a/_develop/localdev/nginx-http-config/storyteller-ssl b/_docs/old/old_localdev_setup/nginx-http-config/storyteller-ssl similarity index 100% rename from _develop/localdev/nginx-http-config/storyteller-ssl rename to _docs/old/old_localdev_setup/nginx-http-config/storyteller-ssl diff --git a/_develop/localdev/startup.sh b/_docs/old/old_localdev_setup/startup.sh similarity index 100% rename from _develop/localdev/startup.sh rename to _docs/old/old_localdev_setup/startup.sh diff --git a/_develop/localdev/ubuntu_setup.sh b/_docs/old/old_localdev_setup/ubuntu_setup.sh similarity index 100% rename from _develop/localdev/ubuntu_setup.sh rename to _docs/old/old_localdev_setup/ubuntu_setup.sh diff --git a/_develop/tools/.gitignore b/_docs/old/old_tools/.gitignore similarity index 100% rename from _develop/tools/.gitignore rename to _docs/old/old_tools/.gitignore diff --git a/_develop/tools/delete_tts_inference_jobs.py b/_docs/old/old_tools/delete_tts_inference_jobs.py similarity index 100% rename from _develop/tools/delete_tts_inference_jobs.py rename to _docs/old/old_tools/delete_tts_inference_jobs.py diff --git a/_develop/tools/find_101soundboards_accounts.py b/_docs/old/old_tools/find_101soundboards_accounts.py similarity index 100% rename from _develop/tools/find_101soundboards_accounts.py rename to _docs/old/old_tools/find_101soundboards_accounts.py diff --git a/_develop/tools/requirements.txt b/_docs/old/old_tools/requirements.txt similarity index 100% rename from _develop/tools/requirements.txt rename to _docs/old/old_tools/requirements.txt diff --git a/_develop/postman_collections/API Tokens Collection.postman_collection.json b/_docs/old/postman_collections/API Tokens Collection.postman_collection.json similarity index 100% rename from _develop/postman_collections/API Tokens Collection.postman_collection.json rename to _docs/old/postman_collections/API Tokens Collection.postman_collection.json diff --git a/_develop/postman_collections/Base Service Collection.postman_collection.json b/_docs/old/postman_collections/Base Service Collection.postman_collection.json similarity index 100% rename from _develop/postman_collections/Base Service Collection.postman_collection.json rename to _docs/old/postman_collections/Base Service Collection.postman_collection.json diff --git a/_develop/postman_collections/Category Routes.postman_collection.json b/_docs/old/postman_collections/Category Routes.postman_collection.json similarity index 100% rename from _develop/postman_collections/Category Routes.postman_collection.json rename to _docs/old/postman_collections/Category Routes.postman_collection.json diff --git a/_develop/postman_collections/GPT4Prompt.txt b/_docs/old/postman_collections/GPT4Prompt.txt similarity index 100% rename from _develop/postman_collections/GPT4Prompt.txt rename to _docs/old/postman_collections/GPT4Prompt.txt diff --git a/_develop/postman_collections/Media Uploads Collection.postman_collection.json b/_docs/old/postman_collections/Media Uploads Collection.postman_collection.json similarity index 100% rename from _develop/postman_collections/Media Uploads Collection.postman_collection.json rename to _docs/old/postman_collections/Media Uploads Collection.postman_collection.json diff --git a/_develop/postman_collections/Profile API Collection.postman_collection.json b/_docs/old/postman_collections/Profile API Collection.postman_collection.json similarity index 100% rename from _develop/postman_collections/Profile API Collection.postman_collection.json rename to _docs/old/postman_collections/Profile API Collection.postman_collection.json diff --git a/_develop/postman_collections/Remote Download Routes.postman_collection.json b/_docs/old/postman_collections/Remote Download Routes.postman_collection.json similarity index 100% rename from _develop/postman_collections/Remote Download Routes.postman_collection.json rename to _docs/old/postman_collections/Remote Download Routes.postman_collection.json diff --git a/_develop/postman_collections/TTS Routes Collection.postman_collection.json b/_docs/old/postman_collections/TTS Routes Collection.postman_collection.json similarity index 100% rename from _develop/postman_collections/TTS Routes Collection.postman_collection.json rename to _docs/old/postman_collections/TTS Routes Collection.postman_collection.json diff --git a/_develop/postman_collections/Trending Collection.postman_collection.json b/_docs/old/postman_collections/Trending Collection.postman_collection.json similarity index 100% rename from _develop/postman_collections/Trending Collection.postman_collection.json rename to _docs/old/postman_collections/Trending Collection.postman_collection.json diff --git a/_develop/postman_collections/User Rating API.postman_collection.json b/_docs/old/postman_collections/User Rating API.postman_collection.json similarity index 100% rename from _develop/postman_collections/User Rating API.postman_collection.json rename to _docs/old/postman_collections/User Rating API.postman_collection.json diff --git a/_develop/postman_collections/Vocoder Service.postman_collection.json b/_docs/old/postman_collections/Vocoder Service.postman_collection.json similarity index 100% rename from _develop/postman_collections/Vocoder Service.postman_collection.json rename to _docs/old/postman_collections/Vocoder Service.postman_collection.json diff --git a/_develop/postman_collections/Voice Conversion API.postman_collection.json b/_docs/old/postman_collections/Voice Conversion API.postman_collection.json similarity index 100% rename from _develop/postman_collections/Voice Conversion API.postman_collection.json rename to _docs/old/postman_collections/Voice Conversion API.postman_collection.json diff --git a/_develop/postman_collections/Voice Designer API.postman_collection.json b/_docs/old/postman_collections/Voice Designer API.postman_collection.json similarity index 100% rename from _develop/postman_collections/Voice Designer API.postman_collection.json rename to _docs/old/postman_collections/Voice Designer API.postman_collection.json diff --git a/_develop/postman_collections/W2L Routes.postman_collection.json b/_docs/old/postman_collections/W2L Routes.postman_collection.json similarity index 100% rename from _develop/postman_collections/W2L Routes.postman_collection.json rename to _docs/old/postman_collections/W2L Routes.postman_collection.json