Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The latest and release-0.1 manuals should be easy to reach to from docs.julialang.org #2753

Closed
ViralBShah opened this issue Apr 4, 2013 · 7 comments
Labels
docs This change adds or pertains to documentation

Comments

@ViralBShah
Copy link
Member

Is there a better way to show the latest and release-0.1 versions of the manual? People cannot guess that the readthedocs icon at the bottom is a clickable drawer that is closed by default. The interface is not easy to use - one frequently has to try a couple of times.

Is there a way to make it so that the default behaviour is that the drawer is open instead of closed, so that the different versions of the manual are all visible when one visits docs.julialang.org?

@JeffBezanson
Copy link
Member

Wow, I never even noticed that icon! I never would have guessed it did something so useful.

@ViralBShah
Copy link
Member Author

Another useful thing to have is that the sidebar should show not only the subsections in the current section, but show all the chapters of the manual, while expanding the one that is currently active. For eg. currently, the sidebar shows the following when reading the Getting Started section.

Table Of Contents

Getting Started
    Noteworthy differences from MATLAB
    Noteworthy differences from R

Instead, the manual would be a lot more navigable if the sidebar in the Julia Manual showed the full ToC:

Table Of Contents

Introduction
Getting Started
    Noteworthy differences from MATLAB
    Noteworthy differences from R
Getting Started
Integers and Floating-Point Numbers
Mathematical Operations
Complex and Rational Numbers
Strings
Functions
Control Flow
Variables and Scoping
Types
Methods
Constructors
Conversion and Promotion
Modules
Metaprogramming
Arrays
Sparse Matrices
Parallel Computing
Running External Programs
Calling C and Fortran Code
Performance Tips

A similar thing would be useful for the standard library too.

@pao
Copy link
Member

pao commented Apr 4, 2013

See also #2123.

@ViralBShah
Copy link
Member Author

The point about the ToC is a dup of #2457

@wlbksy
Copy link
Contributor

wlbksy commented Apr 8, 2013

How about write these links to sidebar directly in html syntax, since the structure of doc won't change much.

@ViralBShah
Copy link
Member Author

Actually, I do expect the structure to change as we go along.

@ViralBShah
Copy link
Member Author

Not sure there is anything meaningful we can do here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

4 participants