Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation #6

Open
AnushkaKohli opened this issue Aug 25, 2023 · 3 comments
Open

Add Documentation #6

AnushkaKohli opened this issue Aug 25, 2023 · 3 comments

Comments

@AnushkaKohli
Copy link

AnushkaKohli commented Aug 25, 2023

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
Copy link
Contributor

a7v8x commented Nov 14, 2023

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
Copy link

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

@Ekundayo39283
Copy link

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 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants