Skip to content

Fix broken anchor fragments in settings and function links#6278

Open
Blargian wants to merge 1 commit into
ClickHouse:mainfrom
Blargian:fix-broken-anchor-typos
Open

Fix broken anchor fragments in settings and function links#6278
Blargian wants to merge 1 commit into
ClickHouse:mainfrom
Blargian:fix-broken-anchor-typos

Conversation

@Blargian
Copy link
Copy Markdown
Member

@Blargian Blargian commented May 26, 2026

Summary

A broken-link sweep of the upcoming Mintlify-rendered docs surfaced ~30 link fragments that point at anchors that never existed on the target heading. All of them are author typos in source content (verified against each target heading's explicit {#id} ID); none are caused by Docusaurus → Mintlify slugifier divergence.

Three patterns are involved:

  • Docusaurus-namespaced prefixes that were never valid IDs. Links use #server_configuration_parameters-user_files_path, #server_configuration_parameters-logger, #server_configuration_parameters-openssl, #server_configuration_parameters-query-log, and #settings-max_threads / #settings-max_insert_block_size. The corresponding target headings are plain ## user_files_path {#user_files_path}, ## logger {#logger}, ## openSSL {#openssl}, ## query_log {#query_log}, ## max_threads {#max_threads}, ## max_insert_block_size {#max_insert_block_size}.
  • Hyphens where the setting ID uses underscores. Links use #parts-to-delay-insert, #parts-to-throw-insert, #min-insert-block-size-rows, #min-insert-block-size-bytes, #max-thread-pool-size. The actual heading IDs are underscore form (#parts_to_delay_insert, etc.).
  • Wrong case on function-name anchors. #cityhash64#cityHash64; the malformed #arraymapfunc-arr1-#arrayMap.

Files changed

  • docs/guides/best-practices/sparse-primary-indexes.md
  • docs/guides/sre/tls/configuring-tls.md
  • docs/integrations/language-clients/rust.md
  • knowledgebase/Insert_select_settings_tuning.mdx
  • knowledgebase/async_vs_optimize_read_in_order.mdx
  • knowledgebase/compare_resultsets.mdx
  • knowledgebase/finding_expensive_queries_by_memory_usage.mdx
  • knowledgebase/how-to-increase-thread-pool-size.mdx
  • knowledgebase/importing-geojason-with-nested-object-array.mdx

Test plan

  • Each rewritten anchor matches an {#id} on the linked target page (verified by grep against docs/operations/settings/*.md, docs/operations/server-configuration-parameters/settings.md, docs/sql-reference/functions/hash-functions.md, docs/sql-reference/functions/array-functions.md).
  • No other instances of these typo patterns remain in docs/ or knowledgebase/ (broad grep, see commit message).

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only link fragment fixes with no runtime or configuration behavior changes.

Overview
This PR fixes broken in-page link anchors across guides, integrations, and knowledge base articles so they match the real {#id} values on target docs (for Mintlify and post-migration link checks).

Anchor corrections fall into three patterns: removing obsolete Docusaurus-style prefixes (e.g. #server_configuration_parameters-user_files_path#user_files_path, #settings-max_threads#max_threads); using underscores where settings IDs use them (e.g. #parts-to-delay-insert#parts_to_delay_insert); and fixing function anchor casing (e.g. #cityhash64#cityHash64, malformed #arraymapfunc-arr1-#arrayMap).

Touched paths include the sparse primary index guide, TLS configuration guide, Rust client docs, and several knowledge base articles (insert/select tuning, async read, result-set comparison, query log, thread pool, GeoJSON import).

Reviewed by Cursor Bugbot for commit 19b50fd. Bugbot is set up for automated code reviews on this repo. Configure here.

Several links across docs/ and knowledgebase/ used anchor fragments that
never existed on the target heading. The Docusaurus-namespaced prefixes
(server_configuration_parameters-X, settings-X) were never valid IDs;
some settings anchors were also written with hyphens where the actual
ID uses underscores; a couple of function anchors used the wrong case.

Surfaced by a broken-link sweep of the upcoming Mintlify-rendered docs;
each anchor below was verified against the target heading's {#id}.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Blargian Blargian requested review from a team as code owners May 26, 2026 10:21
@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

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