FEAT: Improve README file and documentation

thigazzz / personal-portfolio

My personal website portfolio

https://thigazzz.github.io/personal-portfolio/

MIT License

3 stars 0 forks source link

FEAT: Improve README file and documentation #2

Open thigazzz opened 8 months ago

thigazzz commented 8 months ago

Description

Currently, the project lacks a presentable presentation (README) and documentation. I will work to make the project presentation straightforward and the documentation clear.

Goals

Add texts about the project, as well as photos of the website and other types of files to improve understanding.

Tasks

Study tools for website documentation.
Implement documentation.

(second issue. i still learning how to do this)

thigazzz commented 8 months ago

README file improved

Add In README:

Introduction
Image site example
Table of content
Built with
Design
Sections
Contributing