Skip to content

docs: proposed structure#3884

Draft
zilto wants to merge 2 commits intodevelfrom
docs/update-sidebar-layout
Draft

docs: proposed structure#3884
zilto wants to merge 2 commits intodevelfrom
docs/update-sidebar-layout

Conversation

@zilto
Copy link
Copy Markdown
Collaborator

@zilto zilto commented Apr 21, 2026

Review the git diff "per commit" to see the before and after of the visual organisation of the docs sections

@zilto zilto self-assigned this Apr 21, 2026
@zilto zilto added the documentation Improvements or additions to documentation label Apr 21, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying with Β Cloudflare Workers Β Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
βœ… Deployment successful!
View logs
docs dcb8be4 Commit Preview URL

Branch Preview URL
Apr 21 2026, 02:01 AM

Comment thread docs/LAYOUT
β”œβ”€β”€ Core concepts
β”‚ β”œβ”€β”€ How dlt works
β”‚ β”œβ”€β”€ Source
β”‚ β”œβ”€β”€ Resource
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could add job here as well (thinking out loud), in case we want to have a unified approach towards docs. there would need to be a "dltHub" label. Just a raw thought, please challenge it

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts:

  • dltHub should have its own docs section and Concepts page
    • this is important because these docs will be maintained in the relevant repository rather than dlt-hub/dlt in the future
  • Job is still an ambiguous word given "Load job" in dlt

Comment thread docs/LAYOUT
β”œβ”€β”€ Sources (β†’ verified-sources/index)
β”‚ β”œβ”€β”€ REST APIs (β†’ rest_api/index)
β”œβ”€β”€ Sources
β”‚ β”œβ”€β”€ [link] 10k+ LLM Context
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Context assets

Comment thread docs/LAYOUT
β”‚ β”‚ β”œβ”€β”€ Advanced
β”‚ β”‚ └── Add incremental configuration
β”‚ β”œβ”€β”€ Cloud storage and filesystem (β†’ filesystem/index)
β”‚ β”‚ └── Incremental
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incremental load

Comment thread docs/LAYOUT Outdated
β”‚ β”‚ β”œβ”€β”€ Vaults
β”‚ β”‚ β”œβ”€β”€ Complex types
β”‚ β”‚ └── Add credentials
β”‚ β”œβ”€β”€ Adjust a schema
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also should go to Schema management

Comment thread docs/LAYOUT
β”‚ β”œβ”€β”€ Contract & evolution
β”‚ β”œβ”€β”€ Export & visualization
β”‚ └── Naming convention
β”œβ”€β”€ ETL
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about "transformations" on the first line of the hierarchy?

|-- Transformations
      |-- ELT
      |-- ETL

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with Alena here, ETL/ELT does not specifically mean Transformation, my instant question is - what were we talking before then? hehe

Comment thread docs/LAYOUT
β”‚
β”œβ”€β”€ Optimizing dlt
β”‚ └── Performance
β”œβ”€β”€ Performance
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid any content on the 0 level, I mean, to open the "Performance" page you should click Performance, but users very often just open the toggle and click pages from the list

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed with your UI concern. Will fix the inconsistent behavior in our docs. Had previously opened a ticket about it: #3520

Comment thread docs/LAYOUT Outdated
β”‚ β”œβ”€β”€ LanceDB
β”‚ β”œβ”€β”€ Qdrant
β”‚ β”œβ”€β”€ Dremio
β”‚ β”œβ”€β”€ Destination (custom)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep this page and rename it to "Reverse ETL"

Comment thread docs/LAYOUT Outdated
β”‚ └── 1.12.1
β”‚
β”œβ”€β”€ Core concepts
β”‚ β”œβ”€β”€ How dlt works
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep it

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looked strange under "Core Concepts". I'll merge it with the early intro pages

Comment thread docs/LAYOUT
β”‚ └── Education (β†’ tutorial/education)
β”‚ β”œβ”€β”€ Fundamentals course
β”‚ └── Advanced course
β”œβ”€β”€ Installation
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about intro? it's a good starting point

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will add it back after installation

Comment thread docs/LAYOUT
β”‚ β”‚ β”‚ └── Requests
β”‚ β”‚ └── [link] 5k+ REST APIs with LLMs
β”‚ β”œβ”€β”€ 30+ SQL databases (β†’ sql_database/index)
β”‚ β”‚ └── OpenAPI Generator
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if it's still relevant, with claude and open api spec you'll get your source in minutes without our generator

Comment thread docs/LAYOUT Outdated
β”‚ β”‚ └── Add credentials
β”‚ β”œβ”€β”€ Adjust a schema
β”‚ β”œβ”€β”€ Dashboard
β”‚ β”œβ”€β”€ Access loaded data (β†’ dataset-access/index)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you want to remove this section completely, or just not sure where to place it?

Dashboard and access can live together under "Data Quality" for example

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, this section is deeply nested and hard to find. Each pages is quite short

Most of this content will go under:

  • the concept pages for Dataset and Relation
  • our canonical tutotrial "how to use dlt" under the section "access loaded data".

Comment thread docs/LAYOUT
@@ -0,0 +1,190 @@
docsSidebar
β”œβ”€β”€ Installation
β”œβ”€β”€ Build with AI
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a part of paid product - dltHub, we should make sure that it's clearly understandable

Comment thread docs/LAYOUT
β”‚ β”œβ”€β”€ Contract & evolution
β”‚ β”œβ”€β”€ Export & visualization
β”‚ └── Naming convention
β”œβ”€β”€ ETL
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with Alena here, ETL/ELT does not specifically mean Transformation, my instant question is - what were we talking before then? hehe

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants