Skip to content

[WIP] Add multi-version previews and dependency-aware incremental rebuilds - #6752

Open
dprotaso wants to merge 5 commits into
knative:mainfrom
dprotaso:incremental-docs-preview
Open

dprotaso wants to merge 5 commits into
knative:mainfrom
dprotaso:incremental-docs-preview

Conversation

@dprotaso

@dprotaso dprotaso commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Adds incremental rebuilds to the local docs preview, using MkDocs' standard live-reload server.

# Preview your working copy at /docs/
./hack/mkdocs.sh

# Include cached releases; working copy is at /development/
./hack/mkdocs.sh --all-versions

# Same thing with Docker
./hack/docker/run.sh --all-versions

No extra flags needed. Markdown body edits reuse release HTML. CSS, JS and image edits skip page rendering. Shared dependencies and page-index changes trigger full rebuilds.

Median build times from three local runs with all versions enabled and release sources cached (excludes browser reload):

Change MkDocs without incremental builds This PR
Initial full build 12.62s 13.10s
Markdown body edit 13.03s 7.48s
CSS asset edit 13.24s 0.95s
Markdown edit adding an anchor 12.99s 21.09s

About 43% less time for Markdown body edits and 93% less for assets. Markdown edits render 358 pages instead of 1,047; asset edits render none.

Anchor changes are slower: we first render the working copy, detect the changed page index, then rebuild all versions so version-selector links stay correct.

@knative-prow

knative-prow Bot commented Oct 27, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dprotaso

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for knative ready!

Name Link
🔨 Latest commit 4590415
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/6ae019bb4265f1eee182de1a
😎 Deploy Preview https://deploy-preview-6752--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@knative-prow knative-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 27, 2026
@knative-prow knative-prow Bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 27, 2026
@dprotaso dprotaso changed the title Add multi-version previews and dependency-aware incremental rebuilds [WIP] Add multi-version previews and dependency-aware incremental rebuilds Oct 27, 2026
@knative-prow knative-prow Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 27, 2026
@knative-prow knative-prow Bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 27, 2026

This branch has not been deployed

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

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant