Skip to content

Initial setup for file serve #1242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Initial setup for file serve #1242

wants to merge 1 commit into from

Conversation

jaapio
Copy link
Member

@jaapio jaapio commented Aug 20, 2025

With this change we provide an internal webserver in the application. And introduce a watch on changes. This introduces a new way of working with guides, allowing users to edit documentation without caring about rerendering.

Optimizations are possible like parsing and rendering a single file to make rerendering faster.

To test this you can run the following steps:

cd app
docker build -t phpdocumentor/guides:local .
cd -
docker run --rm -it -v $(pwd):/project -w /project -p 1337:1337 phpdocumentor/guides:local /project/vendor/bin/guides serve --output=./output docs

We need to build a local docker image because we need some extra php extension to watch file changes.

With this change we provide an internal webserver in the application.
And introduce a watch on changes. This introduces a new way of
working with guides, allowing users to edit documentation without
caring about rerendering.

Optimizations are possible like parsing and rendering a single
file to make rerendering faster.
@garvinhicking
Copy link
Contributor

When editing a file on my macOS (Orbstack) I only get this:

string(24) "Unhandled event mask: 10"

and the file is not re-rendered.

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