Implemented documentation for single file hosting and React client-side routing for Caddy README.md Cheat Sheet #907
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
…t Client-Side Routing Sections
-Added a section in the README.md cheat sheet for hosting a single file, which provides two methods for serving files.
-Added a section for handling React's client-side routing with descriptions of the implementation and purpose of waterfall system.
-Fixed issues with spacing and syntax in README.md cheat sheet.
|
Thanks for starting on this @rs-dkd. I'm just now getting around to going through some PRs and issues. Did you test these configurations with caddy? Just looking at them, I'm pretty sure some of these are misconfigured. Also, there are a few spelling mistakes that could be corrected with vim-spell or vscode Code Spell Checker. |
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:
Pull request includes improvements to documentation in the Caddy section of main by adding information for the following sections:
-Hosting a single file: Two methods are provided for serving a single file, describing the purposes and usage cases for both.
-Handling React's Client-Side Routing: Guidance and explanation behind using React with Caddy for setting up the server and explains the waterfall process and steps involved.
Changes:
-Added two sections to the table of contents at the beginning of the README.md cheat sheet.
-Added a section in the README.md cheat sheet for hosting a single file, which provides two methods for serving files.
-Added a section for handling React's client-side routing with descriptions of the implementation and purpose of the waterfall system.
-Fixed issues with spacing and syntax in the README.md cheat sheet.
Purpose:
Fix existing issues regarding lacking documentation in the Caddy for developers section within the README.md for users using React's routing system and those looking to host a single file. Helping to benefit efficient hosting through user-friendly documentation and sample deployment cases.