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

Aggregating documentation in one place #528

Closed
mateuszbaran opened this issue Aug 31, 2022 · 4 comments
Closed

Aggregating documentation in one place #528

mateuszbaran opened this issue Aug 31, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@mateuszbaran
Copy link
Member

I've just seen this package in the new packages feed: https://github.com/JuliaComputing/MultiDocumenter.jl . Maybe it would be nice for users to have all manifold package documentations in one place?

@mateuszbaran mateuszbaran added the documentation Improvements or additions to documentation label Aug 31, 2022
@kellertuer
Copy link
Member

What would be the advantage of that? We would have just one place running the docs which we would have to trigger?

I do not completely see an advantage, but sure I wanted to do a common landing page for all packages, then we could do one package for the docs, just that I fear it might be quite some work to change that?

@mateuszbaran
Copy link
Member Author

The advantage would be that it would be possible to search for any functionality in one place instead of going through separate documentation systems. Such documentation could be linked from an overview page (like in #406) and I think exist parallel to package-specific docs, not instead of them -- if I understand MultiDocumenter.jl. So there would be very little to change, likely only some tweaks to cross-docs links.

@kellertuer
Copy link
Member

If both would exist, that doubles information, which has two dangerous sides: (1) inconsistencies (2) confused users. SO I would not introduce that parallel to the specific ones but replace the specific ones with this one large one (maybe on an overview site). And the main change would be where manoptjl.org links to ;)

@kellertuer
Copy link
Member

This is now done at https://juliamanifolds.github.io/ .

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
Projects
None yet
Development

No branches or pull requests

2 participants