feat: add hot-reload watcher to CrocoDocs CLI#6402
Open
ndonkoHenri wants to merge 7 commits intorelease/v0.85.0from
Open
feat: add hot-reload watcher to CrocoDocs CLI#6402ndonkoHenri wants to merge 7 commits intorelease/v0.85.0from
ndonkoHenri wants to merge 7 commits intorelease/v0.85.0from
Conversation
Contributor
Author
|
@sourcery-ai review |
Deploying flet-website-v2 with
|
| Latest commit: |
6041805
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://dd0f3f56.flet-website-v2.pages.dev |
| Branch Preview URL: | https://crocodocs-hot-reload.flet-website-v2.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a crocodocs watch command to support hot-reload workflows by regenerating CrocoDocs artifacts on filesystem changes, and wires this into the website dev-start flow.
Changes:
- Introduces a standard-library polling watcher (
crocodocs watch) that reruns generation after a debounce window and can manage a long-running child process (e.g., Docusaurus). - Refactors the CrocoDocs CLI to share generate-related flags between
generateandwatch, adding watcher-specific options. - Updates website/docs developer workflows (
website/package.json, Taskfile, and CrocoDocs README) to use the watcher duringyarn start.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/package.json | Routes yarn start through crocodocs watch so docs artifacts regenerate while the dev server runs. |
| tools/crocodocs/src/crocodocs/watch.py | New watcher implementation: scans targets, detects changes, debounces, regenerates, and optionally runs/stops a child process. |
| tools/crocodocs/src/crocodocs/cli.py | Adds watch subcommand and shared flag plumbing for generation-related overrides. |
| tools/crocodocs/README.md | Documents the new watch workflow and updates local dev instructions. |
| sdk/python/Taskfile.yml | Updates serve-docs task to use the new hot-reload start path. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying flet-examples with
|
| Latest commit: |
6041805
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0f4136af.flet-examples.pages.dev |
| Branch Preview URL: | https://crocodocs-hot-reload.flet-examples.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Add a CrocoDocs file-watching CLI workflow for hot-reload docs development.
New Features:
Bug Fixes:
Enhancements:
Build:
Documentation: