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

Cleaning up the documentation menu #200

Closed
mateuszbaran opened this issue Jul 16, 2020 · 10 comments
Closed

Cleaning up the documentation menu #200

mateuszbaran opened this issue Jul 16, 2020 · 10 comments
Assignees
Labels
documentation Improvements or additions to documentation restructure

Comments

@mateuszbaran
Copy link
Member

The menu on the left hand side of our documentation is quite chaotic at the moment, we should make it more organized.

@mateuszbaran mateuszbaran added documentation Improvements or additions to documentation restructure labels Jul 16, 2020
@kellertuer
Copy link
Member

Maybe we could first look for a good organisation here?
I think it would be nice to have About and Contributim further up. What do you propose for the structure in order to be more organised?

@mateuszbaran
Copy link
Member Author

Maybe we could first look for a good organisation here?

Yes, that's what I've opened this issue for 🙂 .

I think it would be nice to have About and Contributim further up. What do you propose for the structure in order to be more organised?

I don't know, many documentation sites don't even have such things in the menu. Documenter itself has Contributing but it's at the very bottom.

Among other things I feel like Statistics and Distributions shouldn't be at the top level and things under the Library item are somewhat arbitrarily selected.

@kellertuer
Copy link
Member

Well what about the following

  • Home
  • ManifoldsBase
  • How To
    • Tutorials... I hope to do a few soon...
  • Manifolds
    • ..long list...
  • $Name
    • Distributions
    • Statistics
    • ... further features, e.g. AD?
  • Misc.
    • About
    • Contribute
    • Notation
  • Library

I am not that much in favour of the current Library items. An Internal functions within Misc would be good. But what about the Public section? AD should go into $Name

and for $Name we need a good name - Features on Manifolds?

@mateuszbaran
Copy link
Member Author

Look good. The public section could maybe be called "Utilities" and go to $Name? We could remove the "Library" section and move all items from there to $Name as well. Maybe @sethaxen would have some suggestions?

@kellertuer
Copy link
Member

Calling "Public" "Utilities" is a good idea I think.

@sethaxen
Copy link
Member

So I prefer How to be named something like Examples, because in principle sample scripts without much annotation could be in there in addition to more elaborate tutorials.

I can't think of a better name for $Name than Features on Manifolds.

@kellertuer
Copy link
Member

I am fine with Examples, my idea with How To or Get Started was to get a reader pointed to the page with the tutorials in the sense that this is a point to directly get started. But Examples is fine with me.

Features on Manifolds (or just Features, since everything is on/with manifolds?) is a good idea.

@kellertuer
Copy link
Member

We are currently missing _jacobian in the docs, see https://github.com/JuliaManifolds/Manifolds.jl/runs/917792384#step:4:151 – should I remove that line when revising the docs anyways?

@mateuszbaran
Copy link
Member Author

You can but #202 changes this part of documentation anyway.

@kellertuer
Copy link
Member

Ok, I might still just remove it to have the docs clean.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation restructure
Projects
None yet
Development

No branches or pull requests

3 participants