[Docs] Merge Diataxis reorg feature branch into main#5669
Open
stichbury wants to merge 11 commits into
Open
Conversation
* done Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> * changes based on reviews Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> * Exclude temporary Diataxis planning docs from Vale These planning docs are removed before merge and only exist to help reviewers track content moves, so they don't need to pass Vale style checks. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> * Remove temporary Diataxis planning docs These planning docs only existed to help reviewers track content moves and are no longer needed. Also revert the now-unnecessary Vale exclusion. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> * review-pr-skill 1 Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> * Update .gitignore Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> * fix vale Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> * Fix Vale sentencelength suggestions in new config docs Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> Co-authored-by: Cursor <cursoragent@cursor.com> --------- Signed-off-by: rashidakanchwala <rashida_kanchwala@mckinsey.com> Signed-off-by: rashidakanchwala <37628668+rashidakanchwala@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
…es) (#5620) * Rollback filename change for explanation pages Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Update crosslinking within docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Update docs/catalog-data/data_catalog.md Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> --------- Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
* Revise data catalog pages to split into Diataxis sections Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Update FAQs to point to new link for data catalog docs Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Add shim heading on dataset factories concept page Preserves the #how-to-override-the-default-dataset-creation-with-dataset-factories anchor on the renamed-to-concept-only page so existing external links continue to land on a matching heading. The shim points readers at the equivalent section on the new how-to page. RTD path-based redirects cannot rescue this anchor on their own because the concept page still exists at its original URL. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> * Fix Vale findings in new prose Splits three over-long intro sentences and replaces a weasel word in the Data Catalog landing page. All four edits are on new prose added by the restructure; the remaining Vale findings on the PR sit on pre-existing content moved into the new files and are intentionally out of scope here. Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Cursor <cursoragent@cursor.com> * Vale fixes Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Cursor <cursoragent@cursor.com> * Vale fixes Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Cursor <cursoragent@cursor.com> * Update mkdocs.yml * Update mkdocs.yml Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> --------- Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Cursor <cursoragent@cursor.com>
stichbury
marked this pull request as ready for review
July 16, 2026 12:13
stichbury
requested review from
AliceCima10,
ElenaKhaustova and
merelcht
as code owners
July 16, 2026 12:13
stichbury
requested review from
SajidAlamQB,
ankatiyar,
jitu5,
lrcouto and
rashidakanchwala
July 16, 2026 12:17
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
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
Over a period of several weeks, @rashidakanchwala and I have reorganised the Configuration and Data Catalog docs to fit the Diataxis pattern (concept pages plus separate how-to pages), and I have tidied the top-level nav so section labels read as topics rather than imperative verbs.
All file removals and renames are covered by existing redirect_maps entries in mkdocs.yml.
Development notes
Rebuilds cleanly and tested by visual inspection. The built docs are here.
Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-byline in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.mdfile