Add related learning catalogue - #3877
Open
lcawl wants to merge 4 commits into
Open
Conversation
lcawl
marked this pull request as ready for review
August 14, 2026 22:32
Contributor
|
Welcome to the first episode of vibe coding with Lisa and Kaarina. |
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.
Relates to #1328
Summary
docs-builder now appends a Related learning section on mapped documentation pages. Links come from a global catalog in docs-builder, not from page authors.
Catalog
config/related-learning.yml(embedded likeproducts.yml)https://URL, and a list of pagesdocs-content://path.md). Unqualified paths fail catalog loadapm-with-elastic→docs-content://solutions/observability/apm/index.mdelastic-agent→docs-content://reference/fleet/index.mdindex-basics→docs-content://manage-data/data-store/index-basics.mddata-types-and-mappings→docs-content://manage-data/data-store/mapping.mdMatching is
{current-repository}://{path-relative-to-docset}, case-sensitive, catalog file order. Missing files do not fail the build; the link simply does not appear.How it renders
After parse, if the page matches the catalog, docs-builder appends:
Related learning, slugrelated-learning-heading)target="_blank"+rel="noopener noreferrer")The H2 is a normal heading, so On this page includes it automatically. If the page has footnotes, the section is inserted before the footnotes group.
Config loading
The catalog is loaded only on
BuildContextfromConfigurationFileProvider. It is not part ofIConfigurationContext, DI, orAssembleContext. Isolated and assembler builds both pick it up because they constructBuildContext.Screenshots
When I run
./build.sh publishbinariesthen use that build to serve thedocs-contentdocs, I see the new section:Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6