Overture docs update - #1089
Open
MitchellShiell wants to merge 9 commits into
Open
Conversation
5 tasks
Arranger's docs covered SQON, introspection, concepts, and the query flow, but had no reference for the GraphQL query API itself (the endpoint, an example query + response, the hits/aggregations shape). Add usage/graphql-api.md documenting POST /graphql, the per-catalogue document-type root with hits and aggregations, the Sort input, the dot->__ field-name convention, and schema discovery via the Introspection API. Cross-link it from Query Processing. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Keeps the docs PR limited to documentation; .dev working notes will land separately.
The site renamed /docs/core-software/* to /build/* to /develop/*, moved /docs/contribution to /develop/contributing, /guides/getting-started to /deploy, and /guides/administration-guides to /use. Each old path only resolved through a redirect hop. Verified every new target against a local site build.
MitchellShiell
force-pushed
the
overtureDocsUpdate
branch
from
July 30, 2026 18:07
1815315 to
0f85ea6
Compare
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.
Documentation for the Overture docs site, plus factual corrections to two in-repo READMEs. No source code changes.
Three new pages, a restructure of
docs/usage/intodocs/reference/, and three corrections to thegraphql-routerREADME's network-search section.New pages
docs/reference/graphql-api.mdsidebar_position: 2.5)POST /graphqlendpoint, SQON and field selection, pagination, sorting, and a pointer to the Introspection API for runtime field discoverydocs/charts.mdsidebar_position: 4)modules/charts/README.md, coveringChartsProviderbatching every registered chart into one GraphQL query, plus three screenshotsdocs/federated-search.mdsidebar_position: 6)modules/graphql-router/src/network/, not from the READMEThe federated search page is new coverage, not a port. A sweep of all 74 remote branches found no dedicated page anywhere, only scattered mentions plus an unmerged 2024 design doc on
origin/search-docswhose design has since diverged from what shipped. The page states up front that federation returns aggregate counts, not documents (there is no federatedhitslist), and records that the feature appears under three names: federated search, network search, and network aggregation, withnetworkbeing what configuration and GraphQL field names use.Restructure
docs/usage/*becomesdocs/reference/*, andusage.mdxbecomesreference.mdx.docs/usage/06-ai-and-automation.mdbecomesdocs/mcp-server.md, promoted out of the reference section to a top-level "Arranger MCP server" page.docs/migration/v3.1.mdbecomesdocs/reference/08-Migration/v3.1.md.07-defaults-and-limitsto06,08-feature-flagsto07.overview.md,setup.md,reference.mdx,02-query-processing.md,06-defaults-and-limits.mdandgraphql-api.md.docs/overview.mdalso gains a Key Features bullet and a federation pathway;01-arranger-configs.mdnotes the optional fifth config file (network.json);05-introspection.md,07-feature-flags.mdandcharts.mdgain federation cross-links.Corrections to
modules/graphql-router/README.md, Network searchThree statements were wrong against the code in
src/network/:___aggregation_not_available___sentinel bucket rather than dropping the field.remoteRequests.headersandremoteNodes[].requests.headerswere presented asarrangerRouteroptions. They aresearch-serverconfig-file properties, normalized into acustomizeRemoteRequestfunction, so passing them to the library directly is a silent no-op. Per-node headers also replace the global list rather than merging with it.documentType: 'FileAggs', which resolves toFileAggsAggregationsand fails discovery.apps/mcp-server/README.mdis updated for the docs-site URL change.Rebased onto
mainCurrent with
main, no conflicts. 11 commits absorbed, four resolved:snake_caseInstead ofkebab-case#1088 renamed them to snake_case onmainwhile this branch still had kebab-case, somainwins on both the tool list and the fullerexecute_querysignature, verified againstapps/mcp-server/src.docs/mcp-server.mdwas combined, keepingmain's newquery_arrangerPrompts block from ✨ Addquery-arrangerSystem Prompt and MCP Serverinstructions(overture-stack/admin#184) #1087 alongside this branch's heading promotion out ofreference/..dev/files follow this branch's ownchore: drop .dev changescommit, so.dev/matchesmainexactly. The exception istech-debt.md, where both entries are kept because they are additive: this branch's OpenSearch entry records why its Makefile change removes thestart-ostarget.mainalso landed eightgraphql-routerchanges around catalogue availability.docs/reference/05-introspection.mdalready documents the resultinghealthy/degraded/unhealthyandavailable/failedvalues and all six error codes, each confirmed present in the code, so that page needed no update.Before merging