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

Proposal: Documentation structuring for fast navigation #31

Open
luav opened this issue Feb 17, 2018 · 2 comments
Open

Proposal: Documentation structuring for fast navigation #31

luav opened this issue Feb 17, 2018 · 2 comments
Milestone

Comments

@luav
Copy link
Contributor

luav commented Feb 17, 2018

It would be convenient to have a single page listing all topics of the documentation like in Boost.Test or Criterion frameworks. It would allow to identify and open the required topic withing one click instead of traversing the existing documentation menu.

Currently mettle provides pretty good tutorial but it is inconvenient to find documentation on any specific topic.

@jimporter
Copy link
Owner

Do you just mean an index or (global) table or contents, or do you mean something more like a reference page that describes all the functions/classes exposed in the API?

@luav
Copy link
Contributor Author

luav commented Feb 18, 2018

I mean the global [hierarchical] table of contents.

The API is also desirable and can be automatically generated using doxygen, which requires annotation of the sources. But, the API can not replace the global TOC to start working with the framework.

@jimporter jimporter added this to the future milestone Oct 10, 2018
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

2 participants