Review docs website
Description
Environment
Attachments
Gliffy Diagrams
Activity

There was a suggestion of including a FAQ page.
We made a list of those questions and we have clarified those in the main documentation.
The questions were: installing TVB from sources, configuring TVB with postgres etc.
At this moment a FAQ page will be redundant and not help.
Discussing with the group:
Paula
NOTE: I think Console interface should have one tab like GUI Guide.
Console users aren't necessary developers and so far it seems the only place to get to that page is through the link in INSTALL.Tim
Because this page (Console interface) is about launching the console, I think this page should be directly included in the install page.
If you agree, I will merge both pages in that sense.Mihai
I was imagining the UserGuide-Shell page to be the place where we describe the console interfaces in detail. A counterpart to the GUI guide. Even though right now it is indeed a small page.The installation page is concerned only with how to start these interfaces. Some overlapping descriptions exist. I felt that they were needed on the installation page because, unlike with the GUI interface, a new user would not know what to expect from them.
These said, I agree that in their current shape where the shell guide is small these may be merged.
I tend to prefer smaller pages with links or sub-pages ( toc trees) to large pages. Large pages tend to confuse me.
Lia
How about instead of merging the two pages, let’s introduce now the extra Tab for the Console Interface usage ?
I think Paula’s comment is also in this direction.
We could have on the “Install & Launch” page only an enumeration of commands on how to launch everything (including iPython notebook, and written with different style that Paula suggests), and everything else (details about profiles, various shell differences, etc) on the “Console Guide” new TAB ?Tim
Yep, I think that's a good idea, trying to keep it simple on this install & launch page while allowing the user to rapidly start everything, and give more details in the respective guide pages.
Details
Details
Assignee

Reporter

Attached are some comments on the new docs website.
It's been nice to see how it has evolved since last year .