waku-org / docs.waku.org

Waku Documentation Portal
https://docs.waku.org
2 stars 6 forks source link

ideas for restructuring SDK/Clients page #49

Closed LordGhostX closed 1 year ago

LordGhostX commented 1 year ago

Background

Waku comprises various SDKs/Clients (nwaku, js-waku, etc.), and it is crucial for the documentation to include comprehensive guides for each of them.

Challenge

I'm currently exploring optimal approaches to organizing the SDK/Clients documentation to ensure it is well-structured, intuitive, and enhances the overall user experience.

Proposed Solutions

Idea 1

Idea 2

Idea 3

Notes

cc: @hackyguru @fryorcraken @danisharora099

LordGhostX commented 1 year ago

Here's a revised idea combining elements from ideas 1 and 2:

fryorcraken commented 1 year ago

Card design is definitely more "sexy" than current implementation page. However I would not spend too much time on styling at this point in time. Depends how we can get a good layout.

I agree "3" is not optimal because we have a good number of SDKs:

I would: