Skip to content

Fix wrapped quoted strings in page frontmatter (invalid YAML) - #366

Merged
Blargian merged 1 commit into
mainfrom
fix-frontmatter-quotes
Oct 15, 2026
Merged

Blargian merged 1 commit into
mainfrom
fix-frontmatter-quotes

Conversation

@Blargian

Copy link
Copy Markdown
Member

Summary

128 pages have a quoted frontmatter value wrapped across a line break with the continuation at column 0:

keywords: ['migrate to ClickStack', 'ClickStack migration guide
', 'ClickStack migration from Elastic', 'ELK', ...]
description: 'Contains log entries with information about files processed by the AzureQueue engine.

It is safe to truncate or drop this table at any time.'

That is invalid YAML: a continuation line inside a block mapping must be indented. Astro's js-yaml frontmatter parser tolerates it, so these pages build today. The spec-strict yaml package that @astrojs/markdown-satteri 0.4 uses (via @astrojs/internal-helpers 0.12) rejects it with Missing closing 'quote, which is the blocker for the Nimbus 0.18.1 upgrade in #365.

This PR rejoins each wrapped string on one line. Nothing else changes.

Scope Files
English 15
Translated copies (ar 16, es 15, fr 16, ja 11, ko 11, pt-BR 16, ru 15, zh 13) 113

English files:

concepts/features/performance/caches/userspace-page-cache.mdx
concepts/features/projections/projections.mdx
reference/data-types/aggregatefunction.mdx
reference/settings/server-settings/settings.mdx
reference/statements/alter/comment.mdx
reference/statements/alter/database-comment.mdx
reference/system-tables/azure_queue_log.mdx
reference/system-tables/delta_lake_metadata_log.mdx
reference/system-tables/filesystem_cache_log.mdx
reference/system-tables/filesystem_read_prefetches_log.mdx
reference/system-tables/s3queue_log.mdx
reference/system-tables/transactions_info_log.mdx
clickstack/ingesting-data/sdks/index.mdx
clickstack/migration/index.mdx
integrations/connectors/data-ingestion/kafka/confluent/kafka-connect-http.mdx

Value changes

Only what the YAML fold itself implies: a line break inside the string becomes a single space. The six system-tables descriptions also contained a blank line, which becomes a space, so their meta description reads as two sentences instead of two paragraphs. Every repaired file was re-parsed with yaml and compared against the lenient js-yaml reading of the original with whitespace normalised; all 128 match.

Translated copies

Edited mechanically with the same join, so the translations deployment keeps building once #365 lands. GeneralTranslation regenerates these from the fixed English source and produces the same result. Two French files needed a manual join (one has an ASCII apostrophe inside a double-quoted description, one is a double-quoted multi-line description).

Verification

  • Frontmatter of all 24,319 .md/.mdx files under the content and locale trees parses with yaml 2.9: 0 errors (was 128).
  • A scoped Nimbus 0.18.1 build containing the 15 repaired English pages succeeds; previously excluded pages render with HTML and Markdown twins, e.g. system.azure_queue_log now has <meta name="description" content="Contains log entries … engine. It is safe to truncate or drop this table at any time.">.
  • Hunks touch frontmatter only (deepest changed line is line 7).

Independent of #365 and safe to merge first; the current Mintlify and Nimbus 0.13.1 builds read the joined strings identically.

🤖 Generated with Claude Code

128 pages (15 English, 113 translated copies) had a quoted frontmatter
value wrapped across a line break with the continuation at column 0, for
example:

  keywords: ['migrate to ClickStack', 'ClickStack migration guide
  ', 'ClickStack migration from Elastic', ...]

That is invalid YAML: a continuation line inside a block mapping must be
indented. Astro's js-yaml frontmatter parser tolerated it, so the pages
built, but the `yaml` package that @astrojs/markdown-satteri 0.4 uses via
@astrojs/internal-helpers rejects it with "Missing closing 'quote", which
blocks the Nimbus 0.18 upgrade (#365).

Rejoin each wrapped string on one line. Values are unchanged apart from
the fold itself: a line break becomes a space, and the blank line inside
six system-table descriptions becomes a space, so those meta descriptions
read as two sentences. Every repaired file was re-parsed with `yaml` and
compared against the lenient js-yaml reading of the original. Translated
copies are fixed the same way so the translations deployment keeps
building; GeneralTranslation regenerates them from the fixed English
source with the same result.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

🕵

Preview Deployment Components Updated (UTC)
Docs preview 🟢 Ready English: 🟢 Ready; no remotes; translations: Production fallback 2026-10-15 10:42 UTC

@Blargian
Blargian merged commit 981ce97 into main Oct 15, 2026
2 checks passed
clickgapai pushed a commit to clickgapai/ClickHouse that referenced this pull request Oct 15, 2026
Join wrapped quoted frontmatter strings so strict YAML parsers accept all documentation pages.

ClickHouse/mintlify-docs-dev#366
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant