tintin icon indicating copy to clipboard operation
tintin copied to clipboard

Make "docs" button obvious

Open domenkozar opened this issue 7 years ago • 3 comments

Hey, great project :)

I've come back a few times to really understand what it's trying to accomplish, then finally looked into doc folder to notice there's more to it than just index.

I think "Documentation" button should be exposed to invite user as "Next" page.

domenkozar avatar Jun 18 '18 18:06 domenkozar

Hi @domenkozar ! Thanks for the issue :smile:

The next version of tintin appends a next and prev button to the end of the page, do you think this is enough?

Maybe we could document the docs button by saying that it will point to the first page? :thinking:

NickSeagull avatar Jun 18 '18 20:06 NickSeagull

Maybe a better solution would be to already show table of contents to the user on the first page (that's how other tools do it like mkdocs or sphinx).

domenkozar avatar Jun 19 '18 11:06 domenkozar

The idea of tintin was also to provide a way of making landing pages for the libraries, so I'm not sure how would affect that part by having a ToC

NickSeagull avatar Aug 01 '18 13:08 NickSeagull