houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Migrate documentation to Mintlify and configure 301 redirects (#15502)

Browse Source 
## Summary
Completes the migration of all documentation from twenty-website to a
new Mintlify-powered documentation site at docs.twenty.com.

## Changes Made

### New Package: `twenty-docs`
- ✅ Created new Mintlify documentation package
- ✅ Migrated 95 content pages (user-guide, developers, twenty-ui)
- ✅ Migrated 81 images
- ✅ Converted all custom components to Mintlify native components
- ✅ Configured navigation with 2 tabs and 94 pages
- ✅ Added Helper AI Agent with searchArticles tool for docs search

### Updated: `twenty-website`
- ✅ Added 11 redirect rules (301 permanent) in next.config.js
- ✅ Removed all documentation content (111 files)
- ✅ Removed documentation routes (user-guide, developers, twenty-ui)
- ✅ Removed documentation components (9 files)
- ✅ Updated keystatic.config.ts
- ✅ Preserved all marketing/release pages

### Updated: Core Files
- ✅ Updated README.md - docs links point to docs.twenty.com
- ✅ Updated CONTRIBUTING.md - code quality link updated
- ✅ Updated SupportDropdown.tsx - user guide link updated
- ✅ Updated Footer.tsx - user guide link updated
This commit is contained in:
Abdul Rahman
2025-10-31 22:14:14 +05:30
committed by GitHub
parent 5f13e6fcf4
commit 9f97be67b1
186 changed files with 254 additions and 11616 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-docs/developers/self-hosting/setup.mdx
+6 -6
View File
@@ -11,7 +11,7 @@ import OptionTable from '@site/src/theme/OptionTable'
# Configuration Management
<Warning>
**First time installing?** Follow the [Docker Compose installation guide](https://twenty.com/developers/section/self-hosting/docker-compose) to get Twenty running, then return here for configuration.
**First time installing?** Follow the [Docker Compose installation guide](https://docs.twenty.com/developers/self-hosting/docker-compose) to get Twenty running, then return here for configuration.
</Warning>
Twenty offers **two configuration modes** to suit different deployment needs:
@@ -27,7 +27,7 @@ IS_CONFIG_VARIABLES_IN_DB_ENABLED=true # default
**Most configuration happens through the UI** after installation:
1. Access your Twenty instance (usually `http://localhost:3000`)
2. Go to **Settings / Admin Panel / Configuration Variables**
2. Go to **Settings / Admin Panel / Configuration Variables**
3. Configure integrations, email, storage, and more
4. Changes take effect immediately (within 15 seconds for multi-container deployments)
@@ -37,7 +37,7 @@ IS_CONFIG_VARIABLES_IN_DB_ENABLED=true # default
**What you can configure through the admin panel:**
- **Authentication** - Google/Microsoft OAuth, password settings
- **Email** - SMTP settings, templates, verification
- **Email** - SMTP settings, templates, verification
- **Storage** - S3 configuration, local storage paths
- **Integrations** - Gmail, Google Calendar, Microsoft services
- **Workflow & Rate Limiting** - Execution limits, API throttling
@@ -46,7 +46,7 @@ IS_CONFIG_VARIABLES_IN_DB_ENABLED=true # default
![Admin Panel Configuration Variables](/images/user-guide/setup/admin-panel-config-variables.png)
<Warning>
Each variable is documented with descriptions in your admin panel at **Settings → Admin Panel → Configuration Variables**.
Each variable is documented with descriptions in your admin panel at **Settings → Admin Panel → Configuration Variables**.
Some infrastructure settings like database connections (`PG_DATABASE_URL`), server URLs (`SERVER_URL`), and app secrets (`APP_SECRET`) can only be configured via `.env` file.
[Complete technical reference →](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts)
@@ -103,7 +103,7 @@ IS_CONFIG_VARIABLES_IN_DB_ENABLED=false
**Required scopes** (automatically configured):
[See relevant source code](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/auth/utils/get-google-apis-oauth-scopes.ts#L4-L10)
- `https://www.googleapis.com/auth/calendar.events`
- `https://www.googleapis.com/auth/gmail.readonly`
- `https://www.googleapis.com/auth/gmail.readonly`
- `https://www.googleapis.com/auth/profile.emails.read`
### If your app is in test mode
@@ -238,4 +238,4 @@ yarn command:prod cron:workflow:automated-cron-trigger
<Warning>
**Environment-only mode:** If you set `IS_CONFIG_VARIABLES_IN_DB_ENABLED=false`, add these variables to your `.env` file instead.
</Warning>
</Warning>