Skip to content

Conversation

@torimwhaley
Copy link
Contributor

@torimwhaley torimwhaley commented Dec 27, 2025

Summary of Structural Changes

This PR reorganizes the documentation structure to create clearer content categories and improve navigation.

📁 Major Directory Restructuring

Developer Documentation Consolidation

  • Created guides/developer/ directory to centralize all developer-focused content
  • Moved 12+ files from references/ and guides/ into guides/developer/:
    • Technical guides: caching, dashboards-as-code, dbt-write-back, sql-runner, virtual-views, validating-your-content
    • Development workflows: explores, filtering-dashboard-in-url, renaming-models-and-fields, using-parameters, vs-code-yaml-validation
    • Best practices: dbt-model-best-practices, preview-projects
  • Created guides/developer/cli/ subdirectory and moved how-to-compile-your-lightdash-project there

Get Started Section Enhancement

  • Moved adding-tables-to-lightdash from guides/ → get-started/develop-in-lightdash/
  • Moved interactive-dashboards from guides/ → get-started/exploring-data/

BI Features Organization

  • Moved user-facing feature docs from references/ → guides/:
  • configure-charts, custom-fields, custom-tooltip, filters, table-calculations
  • Created guides/embedding/ directory and moved embedding content there

Contact & Support

  • Centralized contact information: moved faqs.mdx to contact/ directory
  • Renamed contact_info.mdx → contact-info.mdx for consistency

🖼️ Image Directory Alignment

  • Reorganized /images to mirror new documentation structure
  • Created subdirectories matching content paths (e.g., images/get-started/develop-in-lightdash/adding-tables-to-lightdash/)
  • Removed unused/orphaned image files

📝 Content Updates

  • Updated docs.json navigation to reflect new file locations
  • Added new file: CONTRIBUTING.md
  • Updated internal links and cross-references throughout documentation

Impact:

This reorganization improves content discoverability by grouping related documentation together and establishing clear content hierarchies for different user personas (developers vs. BI users).

@jpetey75 jpetey75 marked this pull request as draft December 27, 2025 16:42
@torimwhaley torimwhaley marked this pull request as ready for review December 27, 2025 16:43
@torimwhaley torimwhaley marked this pull request as draft December 27, 2025 16:44
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.

2 participants