Abhishek-Mallick / Abhishek-Mallick/universal-box

[Docs]: Documentation Refactoring for docs website

Open Beginner friendly
#147 0 comments 0 reactions 0 assignees View on GitHub
docs documentation hacktoberfest no-code
Dominant language
JavaScript
Stars
47
Forks
41
PR merge metrics
No merged PRs in 30d

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

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.

Contributor guide

Open the contributing guide

Research direction

Start by forking the repo and running the docs website locally from the `website` folder with `npm install` and `npm run dev`. The tasks involve creating markdown files in `website/content/Templates/` by referencing existing examples (like v2.md) and running local template projects to gather screenshots and details. Focus on one template at a time, following the provided format links. Check the Discord for questions.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown, node.js, react
Domain
content, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.