refactor: rewrite forge doc server using axum #6324
Merged
Conversation
This file contains 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
mattsse
approved these changes
Nov 16, 2023
| use tower_http::services::{ServeDir, ServeFile}; | ||
|
|
||
| /// The HTTP endpoint for the websocket used to trigger reloads when a file changes. | ||
| const LIVE_RELOAD_ENDPOINT: &str = "/__livereload"; |
There was a problem hiding this comment.
oh hell yeah,
I think for reloading we'd need a watch service that runs forge doc?
There was a problem hiding this comment.
This was half-implemented. I can open a follow up implementing this
There was a problem hiding this comment.
sweet,
I can't really remember how the watchexec API works, but I believe it was registering an action via a closure, maybe the forge watch command is helpful a reference, perhaps not
Comment on lines
+39
to
+41
| /// Open the documentation in a browser after serving. | ||
| #[clap(long, requires = "serve")] | ||
| open: bool, |
DaniPopes
force-pushed
the
dani/doc-axum
branch
from
b584274 to
7fabaa2
Compare
onbjerg
approved these changes
Nov 16, 2023
This was referenced Apr 26, 2024
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.
Motivation
We're already using
axumfor Anvil, let's not use another one for no reason.Solution
forgebinary crate since it's pretty heavy dependency-wise.--opento open the docs in a browser after serving them.