Again, pulling several emails into one piece. On Mon, Oct 11, 2010 at 5:06 PM, Christoph Zwerschke <[email protected]> wrote: >> One of my long term goals is to provide three versions of the docs: >> HTML, PDF, and ePub. > > Which will not be so hard since it's supported by RST/Sphinx.
That's actually part of the reason to do it. Having the docs available in so many ways can only be a good thing, I think. > So maybe we should completely dismiss the sidebar, and use clean, small tocs > at the top, and properly working breadcrumbs instead. The SQLAlchemy docs > are a good example: http://www.sqlalchemy.org/docs/ Actually, for us, right now, I think the layout you did is an excellent start. So much so, that I'm going to ask if you could provide an hg repo I could clone, or other way to get your source files. My attempts are not coming out well at all. On the issue of navigation depth, my goal is that every document be no more than two clicks (docs home -> sub category -> document). After that, the doc might have a table of contents, but that's it. End result is something that should be quickly navigable, and not overly deep. On Tue, Oct 12, 2010 at 6:28 AM, werner <[email protected]> wrote: > I use SA and while the documentation is incredible, the lack of the side bar > is something I miss. On my monitors (17 inch notebook and 22 inch desktop) I > have about 300 - 400 pixels white space on both sides with the SA doc - > space for a sidebar :-) . Those sorts of statements bother me, more than you might think. From everything I've been able to tell, current common resolutions for monitors are still under 1280x1024. Many developers have larger resolutions, and many non-developers do, too. But these are still the exception. It's better to design around the smaller, and let it grow, than to use the larger, and watch all the regular people complain about being unable to use the site. I don't want to go higher than 1280x1024. Not for this. It's not needed, and not beneficial enough at this time. > Very much like Christoph's sample, with the exception that I would put the > sidebar on the right side, i.e. out of the way but it is still there when I > want/need to search use the TOC to jump else where. Not sure if the top and > bottom need to be sticky too, and the actual documentation section doesn't > need to be as wide as it is. Maybe similar to Sphinx but with sticky sidebar > - http://sphinx.pocoo.org/tutorial.html? I might be willing to go with the "make a top nav bar that's sticky", but I would not agree to both. It gets too close to having a framed in middle area for content, and is very visually unappealing to me. On Tue, Oct 12, 2010 at 9:57 AM, Emmanuel Cazenave <[email protected]> wrote: > I've used TG for a couple of days. I'v been very disturbed by the fact > that there are two different templates for the doc. I've got to ask: Why is it disturbing? TG 2.0.x is the current stable version. TG 2.1 is under development, including documentation enhancements to fix the shortcomings we have identified in the 2.0.x docs. It's only natural that we work on making the new docs look the best that we can make them look. -- Michael J. Pedersen My IM IDs: Jabber/[email protected], ICQ/103345809, AIM/pedermj022171 Yahoo/pedermj2002, MSN/[email protected] -- You received this message because you are subscribed to the Google Groups "TurboGears Trunk" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/turbogears-trunk?hl=en.
