Link back to "home"? about codo HOT 4 CLOSED

I've taken over the design and most behavior from YARD to not make me think about the details and first get Codo work. I agree it would be better to replace the index with a home to go directly to the README if there is any.

from codo.

There is currently no direct link back to the README, but the README and all other files, classes, etc. are part of the index page, so you can navigate back to the README. I'm not sure where to put the index page when the root will be the "home" (README) and decided to not change it at the moment, although I like the idea.

The root is that I'm currently very unhappy with the grown Codo code base and I really need to refactor it, introduce proper binary tree search operations and change the parsing logic from class oriented to function oriented, better decouple the template generation, provide a better default theme as a JS single page app without any frames but with integrated server that can be used on coffeedoc.info, a.s.o.

Because that's a lot of work I try to only fix bugs of exiting functionality and not introduce new or change working stuff, so I can concentrate on Codo 2.

from codo.

I totally hear you on the refactor. Don't worry about the big-picture change -- I completely understand and agree that can wait.

I'm asking to address a problem that's a bit more specific. I agree that the index has a link back to the readme, but my thought is that as a user, I don't necessarily put 2+2 together and realize that what I'm trying to get back to is the readme file. I'm just trying to get back to the homepage / "main" page.

(And that's actually honest -- it was only after your message here that I realized that (a) the index lists files too, not just classes, and (b) that README is there. I totally missed both those things as a user.)

May I suggest taking a similar approach as you do on "CoffeeDoc.info", which is to just add a new link to the homepage at the beginning of that breadcrumb bar?

[Title of Libary] >> [Index] >> Current File/Class

Sorry to pester on this -- it just feels so essential from a usability perspective. I'm finding myself repeatedly craving an easier way to return to the main page. Thanks for your consideration!

from codo.

Thanks so much! This looks great and helps a lot.

from codo.