Add documentation setup guide for the project#625
Add documentation setup guide for the project#625nouri-devv wants to merge 2 commits intothoth-tech:mainfrom
Conversation
ibi420
left a comment
There was a problem hiding this comment.
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.
|
Hi @ibi420, thank you for the feedback. |
HasinduWelarathne
left a comment
There was a problem hiding this comment.
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 !
MillicentAmolo
left a comment
There was a problem hiding this comment.
The documentation is clear and easy to follow. Actually, this is an excellent work.
There was a problem hiding this comment.
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.
Description
A new documentation that will help future students to be able to set up and run the documentation environment.
Type of change
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:
Checklist: