palmtreefrb / docs

Documentation for fullstackhero project.

FullStackHero's Documentation

How to contribute?

1. Fork this Repository to your Github Profile.
2. Navigate to your newly forked Repository -> Settings -> Secrets.
3. Here, Add a new Repository Secret with a name GT_TOKEN. As for the value, paste in your GitHub Token (https://github.com/settings/tokens)
4. Now, clone this repository locally.
5. Ensure that you have Node.js and Visual Code installed.
6. At the root of the repository run npm install. This installs all the required packages.
7. All the documentations are to be written in markdown format.
8. Refer https://github.com/fullstackhero/docs/blob/main/content/dotnet-webapi-boilerplate/general/getting-started/index.md to get an idea on how to write documentation and include images, code snippets and stuff.
9. To run the application locally, run the command npm run start and navigate to localhost:1313
10. Once ready, send a Pull Request.