Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard

Published 20 hours ago • verified publisher icon LAION-AI

More prominent link to the docs in the Readme

Open mashdragon opened this issue 2 years ago • 2 comments

It wasn't until I stumbled across the docs/ folder that I realised there was more documentation than just the Readme file and the web application. I think it would be useful to add a more prominent link to the docs in README.md. I see the little green badge is there, but I did not notice it the first ten times I read the Readme.

mashdragon avatar Jan 12 '23 00:01 mashdragon

@mashdragon This issue seems to have gotten lost a bit but if you'd like to make a PR adding a suitable link that would be great!

olliestanley avatar Feb 06 '23 22:02 olliestanley

Made this to help visibility a bit more

https://github.com/LAION-AI/Open-Assistant/pull/1277

andrewm4894 avatar Feb 06 '23 22:02 andrewm4894

Is this issue still open. I would like to work on this part of documentation

jaivanti avatar Feb 08 '23 16:02 jaivanti

#1277 is merged now so I think this particular issue is resolved, but if you have other ideas for the documentation feel free to raise an issue and work on them @jaivanti

olliestanley avatar Feb 08 '23 16:02 olliestanley