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

Published 20 hours ago • verified publisher icon LAION-AI

Add prominent link to Guidelines pages to web app

Open andreaskoepf opened this issue 2 years ago • 7 comments

A trivial but high-impact change: Add a prominent link to the Guidelines page in the OA web app.

  • link in the tab bar on the side
  • change the link of every "?"-button of the tasks to the guidelines pages (unless we have better task-specific documentation)

[This is a duplicate of #1320 with a more direct call for action.]

andreaskoepf avatar Feb 17 '23 13:02 andreaskoepf

@andreaskoepf can you explain the issue. I would like to work it, but didn't understand the point you have listed.

CoffeeGeek101 avatar Feb 17 '23 14:02 CoffeeGeek101

The goal is to make the Guidelines document more accessible for every user. Currently it is "buried" somewhere in the documentation. It can only indirectly be reached.

Sketch for side menu (sorry, I am no designer): image

The "Guidelines" entry would be a 'fake' tab, e.g. it could open an anchor-tag with target="_blank" ...

Additionally to this we have several "?" help buttons on the task pages, which currently lead to placehoder pages, like https://projects.laion.ai/Open-Assistant/docs/tasks/reply_as_assistant .. these links could be changed to directly to point to the guidelines document (until we have content for the individual tasks).

andreaskoepf avatar Feb 17 '23 15:02 andreaskoepf

@andreaskoepf I had to chuckle, yes, SO big should it be 😄

I think in a not annoying way, it should, it automatically attracts the user's attention, as it really has a big impact for data quality and prevents uncertainty (many people do ask about it on Discord) when people find the guidelines.

blankster avatar Feb 17 '23 15:02 blankster

SO big should it be

Of course the tab should use the same font-style as the other entries and with a nice docs icon, maybe book or document or similar ..

andreaskoepf avatar Feb 17 '23 15:02 andreaskoepf

@andreaskoepf okay I think I get the problem we are solving here, I'll set up the project locally and try run it. I'll be reaching out to you if I get any confusion along way.

CoffeeGeek101 avatar Feb 17 '23 16:02 CoffeeGeek101

@CoffeeGeek101 thanks a lot. BTW you can also reach us directly on the OA discord server, just ping ollie, blankster or me.

andreaskoepf avatar Feb 17 '23 21:02 andreaskoepf

I went ahead and made the guideline changes @andreaskoepf https://github.com/LAION-AI/Open-Assistant/pull/1757 Let me know if this was alright.

owenduncansnobel avatar Feb 20 '23 08:02 owenduncansnobel