govuk-frontend icon indicating copy to clipboard operation
govuk-frontend copied to clipboard

Improvement: Enhanced Documentation for npm and Gulp Tasks

Open adarsh-jha-dev opened this issue 1 year ago • 3 comments

In this PR, I have made improvements to the documentation regarding the npm and Gulp tasks used in the project. The changes include:

  • Adding clear headings to organize the content.
  • Grouping related npm scripts and Gulp tasks together for easier reference.
  • Providing detailed descriptions of what each script or task does.
  • Using code formatting for command-line instructions to make them stand out.
  • Clarifying the purpose of each section to provide context for users.
  • Reformatting command-line commands for better readability.

These changes aim to enhance the clarity and structure of the documentation, making it easier for users to understand and work with the project's tasks.

adarsh-jha-dev avatar Oct 19 '23 17:10 adarsh-jha-dev

Can any of the maintainers please have a look at the PR and merge it if the changes are found relevant?

adarsh-jha-dev avatar Oct 25 '23 03:10 adarsh-jha-dev

Hi @adarsh-jha-dev - I've added this to our workflow so the team can take a look at it. Thanks for submitting!

domoscargin avatar Oct 25 '23 15:10 domoscargin

Hi @adarsh-jha-dev - I've added this to our workflow so the team can take a look at it. Thanks for submitting!

Thanks a lot, will be pleased if merged successfully.

adarsh-jha-dev avatar Oct 25 '23 15:10 adarsh-jha-dev