docs: Separate technical reference docs from tutorials#3748
Open
BillionClaw wants to merge 1 commit intodlt-hub:develfrom
Open
docs: Separate technical reference docs from tutorials#3748BillionClaw wants to merge 1 commit intodlt-hub:develfrom
BillionClaw wants to merge 1 commit intodlt-hub:develfrom
Conversation
Restructure documentation sidebar to better differentiate between: - Tutorials (learning-oriented, step-by-step) - How-to guides (task-oriented) - Core concepts (understanding-oriented) - Reference (technical reference, CLI, API) Changes: - Create new 'Tutorials' section with REST API, SQL database, filesystem, and education content - Create new 'How-to guides' section consolidating all walkthroughs, deployment guides, and transformation guides - Simplify 'Getting started' to focus on installation and intro - Move walkthroughs from 'Using dlt' to 'How-to guides' - Consolidate 'Deploying dlt' into 'How-to guides' - Move reference content (performance, FAQ) to 'Reference' section - Update 'Reference' section description to clarify technical nature Fixes dlt-hub#3742
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
1 participant
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.
Description
Restructures the documentation sidebar to better differentiate between documentation types, addressing the issue that technical reference docs and tutorials were mixed together.
Changes
New Structure (Diátaxis-inspired)
Getting started - Simplified to intro, installation, LLM tooling, and playground
Tutorials (NEW) - Learning-oriented, step-by-step content:
How-to guides (NEW) - Task-oriented guides:
Core concepts - Understanding-oriented content:
Sources - Verified source connectors
Destinations - Destination connectors
Using dlt - Simplified to dashboard and data access
Code examples - Example code snippets
Reference - Technical reference material:
Release highlights - Release notes
Benefits
Fixes #3742
CLA
I have read and understand the CLA agreement and hereby agree to its terms.