Docs: restructure for Mintlify sync workflow#187
Open
Blargian wants to merge 5 commits into
Open
Conversation
Overwrites docs/*.md with the body of the corresponding Mintlify .mdx
in the docs repo (frontmatter stripped). Purpose is verification only:
the diff vs main should show every change as a Mintlify-shaped
transformation - explicit {#anchor} IDs on headings, Note/Tip/Steps
JSX wrappers, internal link rewrites, dropped TOC/H1, sentence-case
heading casing, contraction edits - and no other content drift.
Do not merge.
- docs/introduction.md → docs/guides/introduction.md - docs/configuration.md → docs/guides/configuration.md - docs/api_reference.md → docs/reference/api-reference.md - docs/installation/* → docs/install/* - Add docs/overview.md (sourced from Mintlify overview.mdx) - Add docs/navigation.json (mirror of the Mintlify navigation block consumed via $ref in the docs site's docs.json) Operator-repo infrastructure (README.md, development.md, styles/, templates/) is left in place. The local navigation paths inside navigation.json reference Mintlify slugs and are kept verbatim - the file is for parity/reference, not for the operator repo's own build. Do not merge - verification branch only.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Blargian
changed the title
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
2 participants
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.
Summary
Restructure
docs/to act as the source of truth for the public ClickHouse docs site (Mintlify). A Mintlify sync workflow will mirror this directory into the docs repo atproducts/kubernetes-operator/**, after which edits to those pages will be disallowed in the docs repo — this repo becomes canonical.Known trade-offs
<Note></Note>which won't render correctly/products/kubernetes-operator/reference/api-reference#podtemplatespec). These resolve correctly once the sync workflow mirrors files into the docs repo, but won't resolve in the operator repo's own GitHub views.Workflow expectations
The companion Mintlify workflow (configured separately) should:
mainpathsdocs/**.docs/<path>.mdxmake the same changes in the upstream repo where the docs site is built fromdocs/navigation.jsonverbatim toproducts/kubernetes-operator/navigation.json(consumed via\$refindocs.json).Test plan
navigation.jsonis correctly consumed via\$refin the docs repo'sdocs.json.#typename,#podtemplatespec, etc.) inapi_reference.mdresolve after sync.Marked draft pending the sync-workflow configuration on the Mintlify side.
🤖 Generated with Claude Code