Repository navigation
Document Enterprise navbar/favicon branding on the Appearance page (+17 more) - #1643
Open
lightdash-bot wants to merge 20 commits into
Open
lightdash-bot wants to merge 20 commits into
lightdash-bot wants to merge 20 commits into
Conversation
lightdash-bot
added
the
cloudy-needs-review
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Documentation validation✅ All blocking checks passed. Component system0 finding(s) across the corpus. Findings on lines this pull request touched are annotated inline in Files changed. |
lightdash-bot
changed the title
…ghtdash YAML project
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs changes Cloudy's docs writer made from support threads on Monday 2 November 2026. One commit per change, described below in order; review by commit and comment on any to drop or change. Every commit builds on current main, so merge whenever it is green, including midday for an urgent fix: later changes that day start a new PR.
Document the MCP project access settings card
Pages
What changes
Why
Admins could not find how to restrict which projects MCP clients can reach, since the docs only covered the org-wide MCP on/off switch and the user-chosen X-Lightdash-Project header.
Checked against
packages/frontend/src/ee/features/aiCopilot/components/Admin/settings/McpProjectAccessSettingsCard.tsxpackages/backend/src/ee/services/McpService/McpService.tspackages/backend/src/ee/services/McpService/mcpProjectAccess.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document MCP allowlist methods and OAuth client ID metadata egress
Pages
What changes
/api/v1/mcp, POST on the OAuth token/register endpointsWhy
Admins allowlisting a self-hosted instance for Claude connectors only had a GET-based, no-egress picture of the required traffic, so their connections hung or failed with a 400 with no matching row to explain it.
Checked against
packages/backend/src/routers/mcpRouter.tspackages/backend/src/routers/oauthRouter.tspackages/backend/src/services/OAuthService/clientIdMetadataDocument.tsCHANGELOG.mdCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document the CI workaround for combining multiple sources into one Lightdash YAML project
Pages
What changes
Why
Readers splitting semantic models across multiple source repos had no documented way to combine them into one native Lightdash YAML project, since the page only documented combining dbt sources, not native ones.
Checked against
packages/common/src/lightdash/loader.tsdocs/native-git-projects.mdA teammate answered a support question that the docs should have covered. Started from this internal Slack thread (Lightdash workspace only).
Document Bedrock inference geography, default-credential and API behavior
Pages
What changes
/api/v1/ai/provider-credentialsAPIWhy
The Bedrock credentials section didn't explain that inference geography (not region) controls data residency, how the organization default gets set on first credential creation, or that credentials can be managed via the API.
Checked against
packages/frontend/src/ee/features/aiCopilot/components/Admin/settings/BedrockCredentialModal.tsxpackages/frontend/src/ee/features/aiCopilot/components/Admin/settings/AiProviderCredentialsCard.tsxpackages/common/src/ee/AiAgent/adminTypes.tspackages/backend/src/ee/models/AiOrganizationProviderCredentialModel.tspackages/backend/src/ee/controllers/AiProviderCredentialController.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document scaling the embed actor across many end users
Pages
What changes
writeActions.userUuidalternative for end users who are Lightdash usersuser.externalIdstill works for trackingWhy
Readers configuring role-based embed permissions for many end users could only see single-actor examples and had no guidance on reusing a small set of service accounts per permission profile instead of provisioning a Lightdash user per end user.
Checked against
packages/backend/src/ee/services/EmbedService/EmbedService.tspackages/backend/src/auth/lightdashJwt.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Explain the 500-row pagination behind slow data app loads
Pages
What changes
Why
Readers debugging a slow-loading data app could only find warehouse query time and caching as explanations, not that large result sets are paginated 500 rows at a time and that pagination itself is the bottleneck.
Checked against
packages/query-sdk/src/apiTransport.tsA teammate answered a support question that the docs should have covered. Started from this internal Slack thread (Lightdash workspace only).
Explain why data apps load slowly with large result sets
Pages
What changes
Why
Readers had no explanation for why an app with a fast warehouse query could still take minutes to load, or how to fix it.
Checked against
packages/query-sdk/src/apiTransport.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Move Scheduled Deliveries and Google Sheets syncs to features that don't cache
Pages
Removed
What changes
Why
The caching page said deliveries and Sheets syncs use and serve cached results, but the scheduler always sets invalidateCache: true (and the headless dashboard render defaults to it too), so they always run a fresh warehouse query.
Checked against
packages/backend/src/scheduler/SchedulerTask.tspackages/frontend/src/pages/MinimalDashboard.tsxpackages/frontend/src/providers/Dashboard/DashboardProvider.tsxCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document the results-cache invalidation endpoints and the clear-cache UI
Pages
What changes
Why
The caching page had no way to find out how to force a cache refresh for a whole project, dashboard, or chart, even though the UI and API both support it.
Checked against
packages/backend/src/controllers/projectController.tspackages/backend/src/controllers/v2/DashboardController.tspackages/backend/src/controllers/v2/SavedChartController.tspackages/frontend/src/components/ProjectResultsCache/index.tsxpackages/frontend/src/components/ProjectResultsCache/ResultsCacheClearScheduleForm.tsxCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Test edit on curate the catalog page
Pages
What changes
Why
Diagnosing a tool error, not a real doc change.
Checked against
packages/backend/src/controllers/catalogController.tsReview closely
This is a larger change than usual:
Cloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document how to turn off content-as-code sync and when uploads release content
Pages
What changes
false+ re-upload), and that it's project-widelightdash uploadreleases content whose file was removed, dismissing its draftsWhy
The page explained turning sync on but never said how to turn it off or that uploads can silently release content from Git management, leaving readers unable to find either behaviour.
Checked against
packages/backend/src/services/CoderService/CoderService.tspackages/cli/src/handlers/download.tspackages/backend/src/services/DashboardService/DashboardService.tspackages/backend/src/services/ContentAsCodeWritebackService/ContentAsCodeWritebackService.tspackages/backend/src/models/ContentAsCodeSnapshotModel.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document run_metric_query's row cap and MCP's lack of an export tool
Pages
What changes
exploreUrl+ All results download, or a scheduled CSV/Excel delivery, for full extractsrun_metric_query's cap isAI_COPILOT_MAX_QUERY_LIMIT, instance-wideAI_COPILOT_MAX_QUERY_LIMITrow now says it also governs the MCPrun_metric_querytoolWhy
The MCP docs described run_sql's row cap but said nothing about run_metric_query's limit, its silent clamping, or that MCP has no export tool, leaving readers with no way to get a full extract.
Checked against
packages/backend/src/ee/services/McpService/McpService.tspackages/common/src/ee/AiAgent/validators.tspackages/backend/src/config/parseConfig.tspackages/common/src/ee/AiAgent/constants.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document LIGHTDASH_DASHBOARD_MAX_CONCURRENT_TILE_QUERIES
Pages
What changes
LIGHTDASH_DASHBOARD_MAX_CONCURRENT_TILE_QUERIESWhy
The environment variables reference had no entry for this self-hosted setting that caps concurrent dashboard tile queries, so admins couldn't find it to control warehouse load.
Checked against
packages/backend/src/config/parseConfig.tspackages/backend/src/config/parseConfig.test.tspackages/frontend/src/features/dashboard/tileQueryQueue/TileQueryQueue.tspackages/frontend/src/features/dashboard/tileQueryQueue/TileQueryQueueProvider.tsxA teammate answered a support question that the docs should have covered. Started from this internal Slack thread (Lightdash workspace only).
Link the Lambda MicroVM build script from the sandboxes prerequisites
Pages
What changes
build-microvm-image.shas the recommended way to produce the two image ARNsRunMicrovmwith the ARN — it never builds or touches ECR/S3 itselfWhy
Readers had to reverse-engineer the AWS API sequence for registering Lambda MicroVM images from prose alone, even though the repo ships a working reference script for the entire pipeline.
Checked against
sandboxes/microvm-agent/build-microvm-image.shsandboxes/data-apps/build-local-image.shsandboxes/ai-writeback/build-local-image.shsandboxes/data-apps/pack-query-sdk.shpackages/backend/src/ee/services/SandboxRuntime/LambdaMicroVmSandboxProvider.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document audit log event contents and access-change coverage
Pages
What changes
Why
Readers could not find what an audit log entry contains or which access changes are fully covered versus only logged as a permission check.
Checked against
packages/backend/src/logging/auditLog.tspackages/backend/src/services/groupMembershipAudit.tspackages/backend/src/services/DirectAccess/directAccessAudit.tspackages/backend/src/services/RolesService/RolesService.tspackages/backend/src/services/UserService.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document audit log event coverage and Lightdash Cloud behavior
Pages
What changes
Why
Readers could see the AUDIT log-level env var but had no page describing what an audit event contains, which actions are covered, or how audit logging works on Lightdash Cloud.
Checked against
packages/backend/src/logging/auditLog.tspackages/backend/src/logging/caslAuditWrapper.tspackages/backend/src/services/RolesService/RolesService.tspackages/backend/src/services/groupMembershipAudit.tspackages/backend/src/services/DirectAccess/directAccessAudit.tsA teammate answered a support question that the docs should have covered. Started from this internal Slack thread (Lightdash workspace only).
Clarify Lambda MicroVMs don't require ECR, just the image ARN
Pages
What changes
create-microvm-image+ an S3codeArtifactzipRunMicrovm, never touching ECR or S3 at runtimeRunMicrovmcallWhy
The page read as if ECR was required to register a Lambda MicroVM image, when it's only the bundled build script's shortcut, and readers couldn't tell what Lightdash's backend actually needs at runtime.
Checked against
sandboxes/microvm-agent/build-microvm-image.shpackages/backend/src/ee/services/SandboxRuntime/LambdaMicroVmSandboxProvider.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document Enterprise navbar/favicon branding on the Appearance page
Pages
What changes
Why
The Brand appearance section said the brand never restyles the navigation bar and that logo upload wasn't exposed in the UI, both now wrong after the Enterprise white-label release that lets admins set a navbar logo, favicon, and tab title.
Checked against
packages/frontend/src/components/NavBar/NavBarLogo.tsxpackages/frontend/src/components/common/BrandedFaviconSync.tsxpackages/frontend/src/components/common/DocumentTitle.tsxpackages/frontend/src/components/UserSettings/AppearanceSettingsPanel/BrandAppearanceSettings.tsxpackages/frontend/src/hooks/organization/useWhiteLabelBrand.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).