Skip to content

Commit

Permalink
Documentation: Improve ending note in README.md
Browse files Browse the repository at this point in the history
Edited the last part of README file to link to issues and pull requests tabs for the repository page (with relative link paths as /issues and /pulls respectively that may only work from the front-page preview and not from the README markdown file source view) and minor formatting update to local server commands that have been tested for local source deployments to highlight them at the end. Additionally, fixes one first word capitalization following ... 'example:' label as it was start of a separate sentence for grammatical correctness.

Signed-off-by: Harshit Gupta <[email protected]>
  • Loading branch information
Git-Harshit authored Dec 23, 2023
1 parent 2fdd9e3 commit 6b9adb4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ This App is ready to be deployed!

#### Built files deployment with a local static server

As homepage property is set to /Quick-Notes under package.json (in order to match deployment path on this dedicated GitHub Pages URL address for its source repository), directly serving from within the build directory with a static server will fail due to mismatching relative paths of linked scripts and stylesheets tied with the source. For this, copy files within or rename build folder itself to folder named "Quick-Notes", and start the server from the parent directory of this folder. Then, open \<static-URL>/Quick-Notes to launch this web application. For example: if this static server has been started on [localhost](http://localhost), then [localhost/Quick-Notes](http://localhost/Quick-Notes) should be able to load the site with all the generated files.
As homepage property is set to /Quick-Notes under package.json (in order to match deployment path on this dedicated GitHub Pages URL address for its source repository), directly serving from within the build directory with a static server will fail due to mismatching relative paths of linked scripts and stylesheets tied with the source. For this, copy files within or rename build folder itself to folder named "Quick-Notes", and start the server from the parent directory of this folder. Then, open \<static-URL>/Quick-Notes to launch this web application. For example: If this static server has been started on [localhost](http://localhost), then [localhost/Quick-Notes](http://localhost/Quick-Notes) should be able to load the site with all the generated files.

Servers such as npm serve and python3 -m http.server have been tried to load generated files for this project.
Servers such as `npm serve` and `python3 -m http.server` have been tried to load generated files for this project.

## Additional references by [React Documentation](https://react.dev)

Expand All @@ -99,4 +99,5 @@ Servers such as npm serve and python3 -m http.server have been tried to load gen

---

This project is currently under development and is available in a ready state. Contributions of all kind are welcome to this project. Go ahead and start a discussion, raise an issue or create a Pull Request. :rocket:
This project is available in a ready state and may get development improvements. Contributions of all kind are welcome to this project.
Go ahead and start a discussion, raise an [issue](/issues) or create a [Pull Request](/pulls). :rocket:

0 comments on commit 6b9adb4

Please sign in to comment.