Skip to content

WIP Full audit and reorg to DRY, sustainable architecture - #1057

Draft
gwenwindflower wants to merge 22 commits into
mainfrom
refactor/full-audit-reorg
Draft

WIP Full audit and reorg to DRY, sustainable architecture#1057
gwenwindflower wants to merge 22 commits into
mainfrom
refactor/full-audit-reorg

Conversation

@gwenwindflower

Copy link
Copy Markdown

Details, plan, and purpose are in ia-audit/ — summary artifact shared internally.

@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

Status

⚠️ 4 broken links need manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 ia-audit/_audit/report.mdx
   📄 ia-audit/ia-rules.mdx
   📄 ia-audit/reorg-plan.mdx
   📄 ia-audit/tree-map.mdx

@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Jul 29, 2026, 12:42 AM

Add simplified guidance with IA rules and audit exceptions system
accessible specifically to mintlify agents
Delete the audit script, the logic has been expanded and ported out to a
TypeScript-based tool in the Cloudy repo for use as a tool by docs
management workflow agents
@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

Status

⚠️ 3 broken links need manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 ia-audit/_audit/report.mdx
   📄 ia-audit/reorg-plan.mdx
   📄 ia-audit/tree-map.mdx

gwenwindflower and others added 12 commits July 31, 2026 01:49
* move 176 pages into product-area directories per ia-audit/move-map.csv
* declare doc-type frontmatter and sidebar pills on all typed pages
* rebuild docs.json nav as root+card area groups in two tabs; 253 redirects
* rewrite internal links and image paths to final URLs, relocate image dirs
* fold merged pages wholesale into targets; add seven area landing pages

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
* rewrite agents landing with one decision guide and comparison table (D11)
* canonicalize dbt field-tagging in data-access; set-up-agents links (D6)
* title MCP pages by call direction: external-in vs agents-out (D33)
* trim ai_hint, verified-answers, evals restatements to links (D27)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
* per-surface embed tutorials link setup and schema instead of restating (D30)
* make react-sdk canonical for CORS; fix broken jwt-structure anchors
* rewrite integrations/slack as one install-use-reference page (D15)
* replace integrations landing card grid with orientation prose
* snowflake-cortex links lightdash-mcp; fix docs-MCP endpoint command

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
… dedup

* rewrite timezones as setup tutorial + daily-use page from draft (D21)
* extract shared impersonation mechanics to a snippet (D9)
* scope sso landing, setup, and verified-domains to distinct jobs (D26)
* drop deprecated okta-groups section; link scim provisioning (D32)
* rewrite workspace-admin landing as governance orientation (D20)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
* extract granularity-placeholder and delivery-destinations snippets (D4, D8)
* correct alerts page to current Power Automate teams flow
* sql-template recipes link their superseding native functions (D29)
* spaces defers to canonical space-roles table (D25)
* formatting walkthrough links format tables in field references (D1)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
* extract shared strict-compilation flags to a snippet (D3)
* split virtual-views and vs-code sections out of content-as-code (D14)
* canonicalize ci secrets in set-up-ci-cd; compile and reference link (D24)
* validate defers to validating-your-content for when validation runs (D23)
* authenticate owns the token-login workaround; install links (D12)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
* rewrite quickstart landing as the three-step golden path
* frame both track landings as persona journeys linking forward (D36)
* extract shared tables-intro to a snippet for both onboarding pages (D7)
* rebuild help/support around the support-routing decision (D19)
* introduction: plain-language framing and hosted MCP endpoint note (D34)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
…ndex

* extract per-feature env tables to snippets shared with the catalog (D5)
* share the nats worker config block across both worker pages (D10)
* unify versioning, upgrade mechanics, migration job, and rollback (D16)
* make the production checklist a true index; facts live on their pages (D31)
* apply scheduler 500m and NATS_ENABLED query-offload semantics; unpin
  browserless versions in prose

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
* extract format, compact, and separator tables to a shared snippet (D1)
* canonicalize the parameters schema; tables and config-yml link (D2)
* caching owns the pre-aggregates comparison; the landing links (D22)
* document group-level ai_hint in writing-descriptions (D27)
* condense the dbt packages section to a current-state reference (D35)
* rewrite the area landing as a short orientation

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCpRRE2XhnfPLRH1ZHmQiS
@gwenwindflower

Copy link
Copy Markdown
Author

Needs engineering sign-off

Plausibility picks applied in this branch (fix in place if wrong):

  1. Scheduler CPU: 500m (was stated as 1 in recommended-resources) — self-host/customize-deployment/scheduler, recommended-resources.
  2. NATS_ENABLED = query-execution offload — env-var catalog row rewritten to match self-host/nats-workers.
  3. Warehouse NATS worker CPU: 250m (checklist said 500m; worker config examples say 250m) — reconciled to 250m.
  4. dbt Fusion: docs still underclaim ("not yet officially verified; dbt Core supported") pending confirmation.

Unresolved contradictions left as-is (need a ruling):

  1. LIGHTDASH_CUSTOM_METRICS_CONFIG_PATH has two conflicting definitions — catalog says YAML config for catalog custom metrics; Prometheus page says JSON config for custom event counters. Same var, different format+purpose. Name collision or drift?
  2. AI_AGENTS_ENABLED vs AI_COPILOT_ENABLED — enterprise-on-prem lists the former; the env-var catalog only documents the latter. Which is current?

Timezone items withheld from the shipped pages until confirmed shipped (from the draft's GLITCH markers):

  1. wall_clock_timezone: per-column source-zone override — live pages say per-column override is not supported; draft said otherwise.
  2. Connection Preview three-value output (raw / interpreted / project-rendered) — kept the simpler description.
  3. ${ldQueryTimezone} custom-SQL template variable — omitted.
  4. Whether the profile Default timezone is admin-gated — kept ungated phrasing.

Also worth a glance: org-settings credentials nav label reconstructed as Organization settings → Credentials (source text was truncated mid-word).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant