monome / norns

norns is many sound instruments.
http://monome.org
GNU General Public License v3.0
629 stars 145 forks source link

consider styling api docs #595

Closed pq closed 4 years ago

pq commented 5 years ago

image

it'd be nice to modernize this a bit.

tehn commented 5 years ago

agreed.

also applies to https://monome.org/docs/modular/teletype/manual/ possibly

jlmitch5 commented 5 years ago

@tehn @pq would be happy to help out with the implementation of this. Do y’all have ideas for the actual design side of things (or ideas of how we could open it to people interested in that from the community)?

pq commented 5 years ago

awesome!

i don't have any ideas specifically... it should just look better. 😬

i wonder if we could crib some CSS from other doc generators? alternatively maybe there are some good more modern lua doc templates we could borrow from?

@tehn : did you have any specific ideas?

tehn commented 5 years ago

no specific ideas but would love to have you take it on. as Phil said, modernizing is a good guiding goal

b

On Wed, Oct 10, 2018, 9:07 PM Phil Quitslund notifications@github.com wrote:

awesome!

i don't have any ideas specifically... it should just look better. 😬

i wonder if we could crib some CSS from other doc generators? alternatively maybe there are some good more modern lua doc templates we could borrow from?

@tehn https://github.com/tehn : did you have any specific ideas?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/monome/norns/issues/595#issuecomment-428783086, or mute the thread https://github.com/notifications/unsubscribe-auth/AAPEcCt3THY0t3SNTmZlMP7yvwq1-VG_ks5ujpm8gaJpZM4XTrHN .

ocreurer commented 5 years ago

Currently working on mocks for the TT manual with @jlmitch5. Should have more extensive designs by the end of the weekend, which could perhaps be re-purposed for the Norns API docs. Will share those in the corresponding thread on lines as soon as they're ready.

tehn commented 5 years ago

success on teletype!