mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-04 10:13:06 +00:00
arc53-machine
5a5226ebe0
The hand-maintained settings page documented 95 of 258 settings and .env-template 42, and both drifted as fields were added. The field descriptions now live on the model, so the reference is rendered from it: python -m docsgpt.core.settings.reference --write writes docs/content/Deploying/Settings-Reference.mdx, one section per settings group with each field's type, default, constraints, aliases and description. --check reports a stale page, and tests/core/test_settings.py fails when the checked-in page no longer matches the definitions, so a new setting cannot land undocumented. test_settings.py also pins the composition contract: every group field is a flat Settings attribute, no field is defined twice, every field has a description, and the secret-normalising validator of every group is applied (the case that a shared method name would silently drop). The App Configuration page points at the reference instead of at settings.py, and the reference is listed in the Deploying navigation.
61 lines
1.6 KiB
JavaScript
61 lines
1.6 KiB
JavaScript
export default {
|
|
"DocsGPT-Settings": {
|
|
"title": "⚙️ App Configuration",
|
|
"href": "/Deploying/DocsGPT-Settings"
|
|
},
|
|
"Settings-Reference": {
|
|
"title": "📖 Settings Reference",
|
|
"href": "/Deploying/Settings-Reference"
|
|
},
|
|
"OIDC-SSO": {
|
|
"title": "🔐 SSO with OIDC",
|
|
"href": "/Deploying/OIDC-SSO"
|
|
},
|
|
"Access-Control": {
|
|
"title": "👥 Access Control & Teams",
|
|
"href": "/Deploying/Access-Control"
|
|
},
|
|
"Docker-Deploying": {
|
|
"title": "🛳️ Docker Setup",
|
|
"href": "/Deploying/Docker-Deploying"
|
|
},
|
|
"Pip-Install": {
|
|
"title": "🐍 Install with pip",
|
|
"href": "/Deploying/Pip-Install"
|
|
},
|
|
"Development-Environment": {
|
|
"title": "🛠️Development Environment",
|
|
"href": "/Deploying/Development-Environment"
|
|
},
|
|
"Kubernetes-Deploying": {
|
|
"title": "☸️ Deploying on Kubernetes",
|
|
"href": "/Deploying/Kubernetes-Deploying"
|
|
},
|
|
"Air-Gapped": {
|
|
"title": "🔒 Air-Gapped Deployment",
|
|
"href": "/Deploying/Air-Gapped"
|
|
},
|
|
"Hosting-the-app": {
|
|
"title": "☁️ Hosting DocsGPT",
|
|
"href": "/Deploying/Hosting-the-app"
|
|
},
|
|
"Postgres-Migration": {
|
|
"title": "🐘 PostgreSQL for User Data",
|
|
"href": "/Deploying/Postgres-Migration"
|
|
},
|
|
"Observability": {
|
|
"title": "🔭 Observability",
|
|
"href": "/Deploying/Observability"
|
|
},
|
|
"Amazon-Lightsail": {
|
|
"title": "Hosting DocsGPT on Amazon Lightsail",
|
|
"href": "/Deploying/Amazon-Lightsail",
|
|
"display": "hidden"
|
|
},
|
|
"Railway": {
|
|
"title": "Hosting DocsGPT on Railway",
|
|
"href": "/Deploying/Railway",
|
|
"display": "hidden"
|
|
}
|
|
}
|