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

Links between the user guide and the reference would be nice #9

Open
sebcrozet opened this issue Sep 4, 2018 · 0 comments
Open

Links between the user guide and the reference would be nice #9

sebcrozet opened this issue Sep 4, 2018 · 0 comments

Comments

@sebcrozet
Copy link
Member

Refer to the original discussion: dimforge/nalgebra#263

nalgebra provides two sources of documentation. The user guide is meant as a high-level description of the library, and is a lots more approachable when trying to discover its functionality, whereas the API documentation provides a more detailed reference suitable for answering more specific questions such as "why won't this code compile".

In this sense, these two forms of documentation are complementary. But currently, they don't link to one another. If I want to know more about a function described in the user guide, I need to manually look it up in the API documentation, through lots of copy and paste in the search box.

It would be nice if there were a way to automatically add links to the API reference in the user guide, so that one could just click on the name of the function in the user guide instead.

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

No branches or pull requests

1 participant