Part of #2023. Prereq: Phase 1 complete (#2026, #2027).
1. Move introduction.qmd to Concepts
docs/getting_started/introduction.qmd is Explanation ("what is Xorq, why it
exists") with no hands-on steps. Getting Started should be purely tutorial.
2. Verify installation.qmd move
Done in Phase 1a. Confirm it happened; if Phase 1 was skipped, move
docs/getting_started/installation.qmd -> docs/how_to/install_xorq.qmd and
update the sidebar.
3. Move Reference docs out of Concepts
Two concepts/ files are actually Reference:
4. Unify the reference hierarchy
Three reference locations: reference/ (auto-gen), api_reference/backends/,
api_reference/cli/.
5. Delete orphaned docs/core_concepts/ root dir
A root-level docs/core_concepts/ exists alongside docs/concepts/core_concepts/.
6. Consolidate style dirs
docs/style/ and docs/styles/ both exist.
Done when
Part of #2023. Prereq: Phase 1 complete (#2026, #2027).
1. Move
introduction.qmdto Conceptsdocs/getting_started/introduction.qmdis Explanation ("what is Xorq, why itexists") with no hands-on steps. Getting Started should be purely tutorial.
docs/concepts/understanding_xorq/what_is_xorq.qmd."What is Xorq?"; update_quarto.yml(remove fromgetting-started sidebar, add to concepts).
docs/index.qmdlinking to the newlocation (search-engine landers).
2. Verify
installation.qmdmoveDone in Phase 1a. Confirm it happened; if Phase 1 was skipped, move
docs/getting_started/installation.qmd->docs/how_to/install_xorq.qmdandupdate the sidebar.
3. Move Reference docs out of Concepts
Two
concepts/files are actually Reference:concepts/understanding_xorq/expression_format.qmd->reference/expression_format.qmd(YAML format spec).concepts/core_concepts/user_defined_exchange_functions.qmd->reference/user_defined_exchange_functions.qmd(UDXF API contract)._quarto.ymlreference sidebar + inbound links.concepts/core_concepts/is now empty (after Phase 1b removed thecaching-internals page), delete the directory.
4. Unify the reference hierarchy
Three reference locations:
reference/(auto-gen),api_reference/backends/,api_reference/cli/.reference/index.qmdadd a "What's here" intro distinguishing the three.caching_classes.qmd,expression_format.qmd,user_defined_exchange_functions.qmdto the reference sidebar.api_reference/intoreference/— just link them clearlyfrom the landing page.
5. Delete orphaned
docs/core_concepts/root dirA root-level
docs/core_concepts/exists alongsidedocs/concepts/core_concepts/..qmd/.md), remove it..qmdfiles, check for duplication, merge if needed, then delete.6. Consolidate style dirs
docs/style/anddocs/styles/both exist._quarto.yml/styles.css); delete the other.Done when
getting_started/is tutorial-only (no introduction, no installation).what_is_xorq.qmdexists and is linked.reference/.core_concepts/root dir gone; one style dir remains.quarto renderpasses, no broken links.