Abhishek-Mallick / Abhishek-Mallick/universal-box

[Docs]: Documentation Refactoring for docs website

未关闭
#147 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
docs documentation hacktoberfest no-code
主要语言
JavaScript
星标
47
派生
41
PR 合并指标
30 天内没有已合并 PR

描述

**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

1. **Creation of Portfolio Website Template writeups**
- Create the markdown file `website/content/Templates/Portfolio-Websites/HTML-CSS/v1.md`.
- **Reference**: Use [this](https://github.com/Abhishek-Mallick/universal-box/blob/main/website/content/Templates/Portfolio-Websites/HTML-CSS/v2.md) 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](https://github.com/Abhishek-Mallick/universal-box/blob/main/website/content/Templates/Portfolio-Websites/React/v2.md) 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.

2. **Fix Documentation Numbering**
- Address the numbering issues in `website/content/Templates/FullStack`.

3. **Enhance FullStack Documentation**
- Review and improve other relevant documentation in `template/FullStack`. Follow [this](https://github.com/Abhishek-Mallick/universal-box/blob/main/website/content/Templates/FullStack/EJS(SSR)%2BNodejs(Backend).md) format
- Fix typos
- Add relevant screenshots for the projects(by locally running them)

4. **Creation of Data Science Prediction Templates**
- Create the markdown files:
- `website/content/Templates/Data-Science/Prediction/Flight-Price-Prediction.md`
- `website/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](https://github.com/Abhishek-Mallick/universal-box/blob/main/website/content/Templates/Data-Science/Prediction/Diabetes-Prediction.md)**

5. **Grammar and Clarity Improvements**
- Fix grammatical issues and improve clarity throughout the documentation project.

## How to run the docs website locally
Pretty easy ✌️
1. Fork this repository
2. Clone the forked repository
```
https://github.com//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](https://discord.com/invite/aWtZQTQPe4) for more real-time communication.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。