arkaroy147 / docs

Documentation and Wiki for Resuminator

Resuminator Docs

This repository contains Resuminator Documentation hosted here. Documentation uses Docusaurus at its core. For basic functionality and work around, Do check out Docusaurus.

Setting Up Local Environment

Pre-requisities

• Node.js version >= 14 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed.

      $ node -v
      v14.15.1

Preparing for Contribution

• Fork this your GitHub account.

• Then clone the forked repository, by typing the following line in your local terminal/powershell. Remember to replace <your-username> with your actual GitHub username.

  git clone https://github.com/<your-username>/docs.git

• Navigate to the cloned repository on your local system

  cd docs

• Add remotes to the parent repository. This will help you fetch the code from the parent repo to avoid any merge conflicts later.

  git remote add upstream https://github.com/resuminator/docs.git

• Finally, fetch the upstream's latest code from the main branch.

  git fetch upstream main

Local Configuration

Now that you have setup the docs repository correctly, the next thing we will focus on is how to configure project to work on your machine and render that beautiful docs.

• Install all the dependencies on your local system using the command given below.

  npm install

• Run the setup.

  npm start

  It should be running at Port 3000.

Creating a pull request

• To create a pull request, check this out

Steps to check out the Markdownlinting issues

• To install as a npm package use npm install -g markdownlint-cli
• To run use markdownlint '**/*.md'

Contributing

All the current issues are being tracked in an Umbrella Issue. Read Instructions there