Docs: API Explorer enrichment author guide - #3946
Merged
Merged
Conversation
reakaleek
force-pushed
the
issue-731-api-docs
branch
from
August 27, 2026 09:27
6980bca to
b19932e
Compare
reakaleek
marked this pull request as ready for review
August 27, 2026 09:28
2 tasks
reakaleek
added a commit
to elastic/docs-content
that referenced
this pull request
Aug 27, 2026
## Why - Assemble `--strict` fails on two redirects that target `kibana://docs/reference/advanced-settings.md` - Kibana link keys are relative to the docs folder, so the published key is `reference/advanced-settings.md` - This breaks assembler-preview on unrelated docs-builder PRs, including elastic/docs-builder#3946 ## What - Change both `applications-ui-settings.md` redirect targets to `kibana://reference/advanced-settings.md` - Keep the `observability-advanced-settings` anchor remap ## Notes - The extra `docs/` prefix landed in #7986 - The `observability-advanced-settings` anchor is valid in the Kibana `main` link index - After this merges to `main`, re-run assembler-preview on docs-builder PR 3946 ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Cursor Grok 4.6 Made with [Cursor](https://cursor.com) Co-authored-by: Cursor <cursoragent@cursor.com>
Mpdreamz
approved these changes
Aug 27, 2026
Authors need a tutorial and a reference for supplemental files, URLs, and validation. Without this, the shipped enrichment behavior stays undocumented. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
The first draft kept CLI and old API Explorer sentences. Several of those claims are false for supplemental files. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
The strict docs build treats a missing page title as a failure. The fixture starts with ## Description for merge, so the docset scanner had no h1. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
reakaleek
force-pushed
the
issue-731-api-docs
branch
from
August 27, 2026 18:32
ea0b6af to
2d3ab03
Compare
Mpdreamz
approved these changes
Aug 27, 2026
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.
Why
api:config, bump.sh URLs, supplemental files, and validation errorsWhat
/api/{key}/paths, reserved slugs, and tag landing URLs so they match the codeNotes
cursor/0fe010e1(ApiExplorer: merge version-suffixed supplemental files #3944)docs-builder api scaffoldcommand is not includedMade with Cursor