Skip to content

docs: preview banner#2518

Open
vladfrangu wants to merge 3 commits into
masterfrom
feat/preview-banners
Open

docs: preview banner#2518
vladfrangu wants to merge 3 commits into
masterfrom
feat/preview-banners

Conversation

@vladfrangu
Copy link
Copy Markdown
Member

It ugle but that's fine :D

Google Chrome Beta - 2026-05-11 at 11-49-36-UTC@2x

@vladfrangu vladfrangu added the adhoc Ad-hoc unplanned task added during the sprint. label May 11, 2026
@github-actions github-actions Bot added this to the 140th sprint - Tooling team milestone May 11, 2026
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label May 11, 2026
@apify-service-account
Copy link
Copy Markdown

apify-service-account commented May 11, 2026

✅ Preview for this PR (commit 72fc463) is ready at https://pr-2518.preview.docs.apify.com (see action run).

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a visible “preview build” banner for PR deployments of the Apify Docs and updates theme CSS so the banner stays pinned at the top without the navbar sliding underneath.

Changes:

  • Adds a Docusaurus announcementBar that appears only on preview/PR hostnames and links back to the PR on GitHub.
  • Adjusts theme CSS to make the announcement bar sticky and offset the navbar when the bar is present.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
apify-docs-theme/src/theme/custom.css Pins the announcement bar to the viewport top and offsets the navbar to avoid overlap.
apify-docs-theme/src/config.js Conditionally enables a PR preview announcement bar based on APIFY_DOCS_ABSOLUTE_URL.

Comment on lines +290 to +292
const absoluteUrl = new URL(process.env.APIFY_DOCS_ABSOLUTE_URL);

const { hostname } = absoluteUrl;

return {
id: 'apify-docs-preview-banner',
content: `You are visiting <a href="${githubUrl}" target="_blank">a preview build for PR ${prNumber}</a> of the Apify Docs.`,
@patrikbraborec patrikbraborec requested a review from TC-MO May 12, 2026 07:12
@patrikbraborec
Copy link
Copy Markdown
Contributor

I guess it's OK, I also added @TC-MO to check it.

Copy link
Copy Markdown
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Visually LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants