Skip to content

Conversation

@nouri-devv
Copy link

Description

A new documentation that will help future students to be able to set up and run the documentation environment.

Type of change

  • [ X] Documentation (update or new)

How Has This Been Tested?

The project was built and run in FirreFox, Chrome and safari. Tested the page and other pages and no error.

Testing Checklist:

  • [ x] Tested in latest Chrome
  • [ x] Tested in latest Safari
  • [ x] Tested in latest Firefox

Checklist:

  • [x ] My code follows the style guidelines of this project
  • [ x] I have performed a self-review of my own code
  • [ x] I have commented my code in hard-to-understand areas
  • [ x] I have made corresponding changes to the documentation
  • [ x] My changes generate no new warnings
  • [ x] I have requested a review from ... on the Pull Request

Copy link

@ibi420 ibi420 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @nouri-devv,

Your documentation is well-formatted in the correct. md structure and clearly outlines the steps required to build Doubtfire-astro locally. My only feedback is regarding the naming convention: avoid spaces in file names and instead use hyphens or underscores. For example, instead of Documentation Project Set Up and Process.md, consider Documentation_Project_Set_Up_and_Process.md or Documentation-Project-Set-Up-and-Process.md.

Aside from that, everything looks great. Thank you for the opportunity to review your work- well done.

@nouri-devv
Copy link
Author

Hi @ibi420, thank you for the feedback.
I have renamed the file to Documentation_Project_Set_Up_and_Process.md.

Copy link

@HasinduWelarathne HasinduWelarathne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nouri-devv,

This is a well-structured and easy to follow guide. The steps are clear and the formatting is consistent with our documentation standards. I think this will be really helpful for anyone setting up the project for the first time.

Looks great !

Copy link

@MillicentAmolo MillicentAmolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation is clear and easy to follow. Actually, this is an excellent work.

Copy link

@returnMarcco returnMarcco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pre-approving this.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please spell check this document and ensure the same spacing is used between headings and content. The content itself is well written and informative. Good work. Will pre-approve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants