Repository navigation
IBX-12652: Added the headless.documentation_url setting - #2146
GrabowskiM wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| return $this->getUrl('headless.configuration_url', $scope); | ||
| } | ||
|
|
||
| public function getDocumentationUrl(?string $scope = null): ?string |
There was a problem hiding this comment.
Probably it shouldn't ever (at least I always call it with argument), but that's convention from all other methods in this class
There was a problem hiding this comment.
I wouldn't call it convention - if we are sure the parameter cannot be null we should skip it. Unless you see a good reason not to. @tbialcz please advice here.
| */ | ||
| public function getConfigurationUrl(?string $scope = null): ?string; | ||
|
|
||
| public function getDocumentationUrl(?string $scope = null): ?string; |
There was a problem hiding this comment.
It can be null on purpose: null means the current siteaccess and it goes straight to ConfigResolver::getParameter() and that's how page-builder and site-context call it
|
Looks good for me. |
…fault Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
There was a problem hiding this comment.
Doc is ready at https://doc.ibexa.co/en/saas/content_management/pages/headless_page_builder/
ibexa/page-builder#629 can target it.
It could specifically target the "Configuration" section but this section will stay on top of page.
| # @todo replace with the headless documentation URL once the page is published | ||
| ibexa.site_access.config.default.headless.documentation_url: 'https://doc.ibexa.co/' |
There was a problem hiding this comment.
| # @todo replace with the headless documentation URL once the page is published | |
| ibexa.site_access.config.default.headless.documentation_url: 'https://doc.ibexa.co/' | |
| ibexa.site_access.config.default.headless.documentation_url: 'https://doc.ibexa.co/en/saas/content_management/pages/headless_page_builder/' |



Related PRs:
Description:
Adds a
headless.documentation_urlsiteaccess setting next toheadless.configuration_url, exposed asHeadlessConfigurationInterface::getDocumentationUrl().The "headless mode not configured" screens in Page Builder and Site Context link to the documentation on connecting a front-end application. Both had their own hardcoded URL; they now read it from this setting, so there is a single default and installations (e.g. SaaS) can point it to their own guide.
https://doc.ibexa.co/, marked@todountil the headless documentation page is published.null; the consuming screens then hide their documentation links.For QA:
Covered by the related PRs: with headless enabled and no preview URL, the Page Builder placeholder and the location View tab link to the configured documentation URL, and hide those links when it is set to
~.Documentation:
New
headless.documentation_urlsiteaccess setting (URL of the documentation on connecting a front-end application, defaults to the Ibexa documentation).🤖 Generated with Claude Code