search

kujtimiihoxha / iris-docs

Redesigned docs for https://github.com/kataras/iris
1 stars 2 forks source link

Use some Material Docs features to make the docs look better. #2

Open kujtimiihoxha opened 8 years ago

kujtimiihoxha commented 8 years ago

@kataras I think we should use material docs features where we can to make the docs more readable. Like ex. Notes and warnings capture

Would it be OK to group the content in some sections so the sidebar gets smaller, I think that how it is done now it look to overwhelming and maybe you could give me some ideas on how the grouping would be done.

Thanks for the help ;)

ghost commented 8 years ago

This will be nice but it will take time to do, keep that as the last-thing todo before publishing?

kujtimiihoxha commented 8 years ago

@kataras What about the sections on the sidebar ? I need to know what to do now.

ghost commented 8 years ago

What do you mean? We miss/forgot some sections, gitbook has more,

kujtimiihoxha commented 8 years ago

Would it be OK to group the content in some sections so the sidebar gets smaller, I think that how it is done now it look to overwhelming and maybe you could give me some ideas on how the grouping would be done.

I mean this.

ghost commented 8 years ago

Hmm I think the group is almost good, the other solution is to group them by context functions iris station's functionalities and global iris functionality but I don't know if that is better than we have now. But you can change them do whatever you're thinking, you're totally free, do the thing you imagine and if you don't like just restore a backup

kujtimiihoxha commented 8 years ago

No problem, I will finish the other sections as in the gitbook, I just thought that it is a rather big sidebar but OK I will tell you when its finished ;)

ghost commented 8 years ago

Yes, finish the basics first and do changes later I don't have the best design-eye, so you know better :P

kujtimiihoxha commented 8 years ago

@kataras I think all the links are finished now. All that remains is that :

If all is good I will build the static files and push them to iris-contrib/website

ghost commented 8 years ago

Ok,

You check if I missed something.

Table of contents | broken links Routing and reverse lookups | http://localhost:1313/routing/ Send e-mails | http://localhost:1313/mail Body binder | http://localhost:1313/request_body_bind/ Examples redirects to http://localhost:1313/examples instead of https://github.com/iris-contrib/examples

Tell me if you want to change the color scheme to match iris.these are the colors available

I would like to use the third color pallete ( from the left-ro-right screen)

kujtimiihoxha commented 8 years ago

@kataras all done :smile: