Document contextual help link contract

2026-08-03 07:35:42 +02:00
parent 6607a3eeae
commit abe2f78fc3
2 changed files with 12 additions and 0 deletions
@@ -184,6 +184,15 @@ Each topic should support stable anchors and related-topic links:
 - pattern topics link to examples and the components that implement them
 - unavailable topics link to the blocker and the actor who can resolve it

+Core exposes `DocumentationHelpLink` for those entry points. A caller supplies
+either a stable topic id (`/docs?type=user&topic=...`) or help-context id
+(`/docs?type=user&context=...`), plus an optional topic anchor. Route help uses
+the context form; field labels and blocker callouts can use either form. The
+component opens the configured Help Center when Docs is active and falls back
+to the hosted documentation site when the optional module is absent. Modules
+must reference topic/context ids, not reproduce Docs routing or inspect another
+module's implementation.
+
 ## Source Contract Direction

 The current `DocumentationTopic` contract can carry the first version through