Skip to content

Conversation

@garvinhicking
Copy link
Contributor

The hot reloading currently only reloads the full page.

However, it would be desirable when doing "live documentation" to reload the page and keeping the current scroll position in sync.

The JavaScript is now adapted to locally store the current position, and restore it after page reload. The temporary sessionStorage is utilized for this, which is tab-specific.

A small timeout ensures that if a page with locationHash is reloaded can properly jump to the stored position.

Debug output is added while this feature is experimental.

Also, the 'ws' URI is auto-detected so it can work on HTTPS and HTTP connections - this is queried via JavaScript and thus can work on reverse proxy setups.

The hot reloading currently only reloads the full page.

However, it would be desirable when doing "live documentation" to reload the page and keeping the current scroll position in sync.

The JavaScript is now adapted to locally store the current position, and restore it after page reload. The temporary sessionStorage is utilized for this, which is tab-specific.

A small timeout ensures that if a page with locationHash is reloaded can properly jump to the stored position.

Debug output is added while this feature is experimental.

Also, the 'ws' URI is auto-detected so it can work on HTTPS and HTTP connections - this is queried via JavaScript and thus can work on reverse proxy setups.
@jaapio jaapio merged commit d9d3357 into phpDocumentor:main Nov 12, 2025
24 of 28 checks passed
@jaapio
Copy link
Member

jaapio commented Nov 12, 2025

Thanks, I will address the failing tests in another PR, this is just php 8.5

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants