-
Notifications
You must be signed in to change notification settings - Fork 118
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
Improve readability and glancability of docs in README.txt #249
Comments
Thanks, @claremacrae for pointing that out. Fixed by c74fb33 |
Thanks @krzysztof-jusiak - having seen the result, I think it would really benefit from a table of contents now, ideally including levels 1 and 2, so users can quickly see the structure, and still jump to bits they are interested in. |
I don't really understand the intention of 02ca5a4 - but it seems to have reverted the fix for this issue - almost all the sections are closed again, as far as I can see, so I think this issue should be re-opened. |
Here are some examples of tables of contents in Markdown pages - so the full text is searchable on the page, and users can quickly see the structure and type of content, and also jump to a particular section very quickly: |
Ah right, now I understand - it has almost reverted to the original behaviour, but it has opened the sections that have sub-sections... So users can see the sub-section titles, but the original issue of not being able to search the whole page (unless you expand every single section and sub-section) has returned. |
What's the benefit of the expanding sections? Could they be replaced with a traditional |
Thanks for your input @claremacrae. Yeah, I'm still experimenting with it with the following goals in mind 🤔
I pushed a change to expand all sections (they can still be collapsed) and added a top menu. |
I like it!!! |
Expected Behavior
That it's easy to search text, and see the whole structure, of the docs on the front page:
https://github.com/boost-experimental/ut
Actual Behavior
Specifications
Suggestions
The text was updated successfully, but these errors were encountered: