[Docs]: Documentation Refactoring for docs website
#147 opened on Oct 19, 2024
Repository metrics
- Stars
- (49 stars)
- PR merge metrics
- (PR metrics pending)
Description
Is your issue related to a specific problem? Please describe.
This issue aims to address the need for refactoring and improving the documentation within the Universal-Box project, particularly in the website/content folder. Due to numerous contributions, several areas require updates and enhancements.
Tasks
-
Creation of Portfolio Website Template writeups
-
Create the markdown file
website/content/Templates/Portfolio-Websites/HTML-CSS/v1.md.- Reference: Use this as a guide to write the markdown file.
- Run the project locally .. directory:
template/Portfolio-Websites/HTML-CSS/v1.. use relevant screenshots or information to populate the markdown.
-
Create the markdown file
website/content/Templates/Portfolio-Websites/React/v1.md.- Reference: Use this as a guide to write the markdown file.
- Run the project locally .. directory:
template/Portfolio-Websites/React/v1.. use relevant screenshots or information to populate the markdown.
-
-
Fix Documentation Numbering
- Address the numbering issues in
website/content/Templates/FullStack.
- Address the numbering issues in
-
Enhance FullStack Documentation
- Review and improve other relevant documentation in
template/FullStack. Follow this format- Fix typos
- Add relevant screenshots for the projects(by locally running them)
- Review and improve other relevant documentation in
-
Creation of Data Science Prediction Templates
- Create the markdown files:
website/content/Templates/Data-Science/Prediction/Flight-Price-Prediction.mdwebsite/content/Templates/Data-Science/Prediction/Stock-Price-Prediction.md- Reference: Refer to the corresponding projects for guidance. Please run the projects locally according to their README files in the template directory. Use this format
- Create the markdown files:
-
Grammar and Clarity Improvements
- Fix grammatical issues and improve clarity throughout the documentation project.
How to run the docs website locally
Pretty easy ✌️
- Fork this repository
- Clone the forked repository
https://github.com/<username>/universal-box.git
cd universal-box
Run the docs website locally
cd website
npm install
npm run dev
Docs website should be live at http://localhost:3000/
Additional Information
If you would like to pick this up but feel that some tasks require further subdivision or clarification, please let me know! We can break down specific tasks into smaller issues if needed. Join Discord for more real-time communication.