Skip to content

Diátaxis: Add "Explanations" section #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2025
Merged

Diátaxis: Add "Explanations" section #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/explain/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
(explain)=
(explanation)=
(explanations)=

# Explanations

:::{div} sd-text-muted
Broaden and deepen your knowledge and understanding of CrateDB subject matters.
:::

The explanatory guides in this section provide more context and background
about applications and use cases of CrateDB, trying to put things into a
bigger picture and joining things together to help answer the question _why_?



:::{note}
You can expect the more recent documents to be more up-to-date than previous
ones. If you can discover any flaws, please report them back to us by
navigating to the tool flyout in the top right corner of each page,
then using "Suggest improvement" to leave your feedback.
:::
18 changes: 15 additions & 3 deletions docs/handbook/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ About using CrateDB and CrateDB Cloud in practice.
:::


::::{grid} 2 2 4 4
::::{grid} 2 2 3 3
:gutter: 2
:padding: 0

Expand Down Expand Up @@ -51,7 +51,7 @@ About using CrateDB and CrateDB Cloud in practice.

How-to guides, tutorials, and explanations.

::::{grid} 2 2 4 4
::::{grid} 2 2 3 3
:gutter: 2
:padding: 0

Expand All @@ -63,7 +63,7 @@ How-to guides, tutorials, and explanations.
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5
{material-outlined}`assistant_direction;1.3em`
{material-outlined}`integration_instructions;1.3em`
:::

:::{grid-item-card} Tutorials
Expand All @@ -77,6 +77,17 @@ How-to guides, tutorials, and explanations.
{material-outlined}`school;1.3em`
:::

:::{grid-item-card} Explanations
:link: explanations
:link-type: ref
:link-alt: Explanations about subject matters concerning CrateDB
:text-align: center
:class-card: sd-pt-3
:class-body: sd-fs-1
:class-title: sd-fs-5
{material-outlined}`lightbulb;1.3em`
:::

:::{grid-item-card} Administration
:link: administration
:link-type: ref
Expand Down Expand Up @@ -247,6 +258,7 @@ programming frameworks, software testing, time series data.
../connect/index
../howto/index
../tutorial/index
../explain/index
../admin/index
../performance/index
../feature/index
Expand Down