search

atherosai / ui

Simple UI examples from my social media
https://learning.atheros.ai
10.51k stars 1.85k forks source link

Add Documentation #6

Open AnushkaKohli opened 8 months ago

AnushkaKohli commented 8 months ago

Issue

The repo looks great, except that if i had to see how a particular component looks, I would be required to clone the entire repo and run each html file separately.

Solution

I would like to document this repo in such a way that any developer can directly look for the component that they want and also be able to see how that component looks exactly and directly access the codebase for that particular document.

a7v8x commented 6 months ago

Nice great note! We plan something like that at learning.atheros.ai, we will be deploying that soon! Some preview would be great also for the repo, though not sure how to do it!

LindezaGrey commented 2 months ago

You could deploy the examples to github pages - this way it would stay up-to-date with the code.

Ekundayo39283 commented 1 month ago

Hi guys, has the documentation issues been resolved I'm learning to contribute to open source and I'm starting with fixing and updating documentations.

Thanks 😅