Skip to content

Docs preview local: path-prefix build#3201

Merged
Mpdreamz merged 2 commits into
mainfrom
chore/docs-preview-build-path-prefix
Apr 28, 2026
Merged

Docs preview local: path-prefix build#3201
Mpdreamz merged 2 commits into
mainfrom
chore/docs-preview-build-path-prefix

Conversation

@Mpdreamz
Copy link
Copy Markdown
Member

Summary

Passes PATH_PREFIX from Generate env.PATH_PREFIX into dotnet run … docs-builder … --strict via --path-prefix "${PATH_PREFIX}", so emitted HTML/static URLs match where we sync in S3 (same prefix).

Problem

Without this, previews under https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/... request /_static/... at the bucket root (404), so the page renders unstyled.

Test plan

  • After merge: run Docs preview (local) on main.
  • Open preview URL and confirm /_static/... requests are under /elastic/docs-builder/tree/main/_static/... (200).

Made with Cursor

docs-builder emits root-relative URLs by default; set --path-prefix to match preview S3 layout so `/ _static/` and links resolve under `/elastic/docs-builder/tree/...` on docs-v3-preview.

Made-with: Cursor
@Mpdreamz Mpdreamz requested a review from a team as a code owner April 28, 2026 19:04
@Mpdreamz Mpdreamz requested a review from cotti April 28, 2026 19:04
Adds a handbook index entry so merges include a docs-path change alongside the preview workflow update, triggering Docs preview local on main.

Made-with: Cursor
@Mpdreamz Mpdreamz requested a review from a team as a code owner April 28, 2026 19:05
@Mpdreamz Mpdreamz added the chore label Apr 28, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 28, 2026

Warning

Rate limit exceeded

@Mpdreamz has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 58 minutes and 30 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 28c39f07-986f-43ca-b2fe-d61dae24a999

📥 Commits

Reviewing files that changed from the base of the PR and between 5ac6390 and 7316a8b.

📒 Files selected for processing (1)
  • docs/index.md
📝 Walkthrough

Walkthrough

The GitHub Actions workflow for local documentation builds has been updated to pass a computed PATH_PREFIX environment variable to the docs-builder tool. The build command now includes --path-prefix "${PATH_PREFIX}" as a parameter, in addition to the existing --strict flag. This change ensures that the path-prefix configuration is explicitly provided to the builder during local documentation preview builds.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: passing PATH_PREFIX to the docs-builder's --path-prefix argument in the local docs build workflow.
Description check ✅ Passed The description clearly relates to the changeset, explaining the problem (404s without PATH_PREFIX), the solution (passing PATH_PREFIX via --path-prefix), and providing a test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch chore/docs-preview-build-path-prefix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Mpdreamz Mpdreamz merged commit f7641a5 into main Apr 28, 2026
22 of 25 checks passed
@Mpdreamz Mpdreamz deleted the chore/docs-preview-build-path-prefix branch April 28, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant