Suggestions for docs

[shikharvashistha]

@bassoy

Parameters	uBlas (old)	uBlas (new)	Tensorflow	pkg go & Go	Python
Easy navigation menu	❌	✅	✔️	✔️	✔️
Separating tutorial & reference	❌	❌	✔️	❌	✔️
Tutorials/Tours	❌	❌	✔️	✔️	✔️
Example code run(god bolt/wand box)	❌	❌	✔️	✔️	❌
Discussion of example code	✅	✅	✔️	✔️	✔️
Documentation of versioning and changes	❌	❌	✔️	✔️	✔️
Link functions and types to actual code	❌	❌	✔️	✔️	✔️
Acknowledgment with contributors and maintainers	❌	❌	✔️	✔️	✔️
Warning/Errors/Undefined behavior	❌	❌	✔️	✔️	✔️
Dark Mode 😅	❌	❌	✔️	✔️	❌
Dictionary search / indexing	❌	❌	✔️	✔️	✔️
Function search / indexing	❌	❌	✔️	✔️	✔️
Quick Search	❌	❌	✔️	❌	✔️
Versioning of documentation	✔️	✔️	✔️	✔️	✔️
Good Formatting 😅	❌	✔️	✔️	✔️	✔️
Separating every container docs	❌	❌	✔️	✔️	✔️
Related links at the end of each file	❌	❌	✔️	✔️	✔️
Compilation log if needed in examples	❌	❌	✔️	❌	✔️
Future improvements	❌	❌	✔️	✔️	✔️
Why (Case studies, why we need it ?, some refs)	❌	❌	✔️	❌	✔️

[bassoy]

• Easy navigation menu: allow only two indentation (tabs). detailed overview should be placed inside the respective page
• For dark mode see boost qvm library with its css files

[shikharvashistha]

@bassoy

Parameters	uBlas (old)	uBlas (new)	Eigen	Numerics	Blaze	Numpy
Easy navigation menu	❌	✔️link	✔️	❌	✔️	✔️
Separating Tutorial & Reference	❌	❌	✔️	❌	✔️	✔️link & link
Tutorials	❌	❌	✔️	❌	✔️	✔️link
Example code run(god bolt / wand box)	❌	❌	❌	✔️link	✔️	❌
Discussion of example code	❌	❌	✔️	✔️	✔️	✔️link
Documentation of versioning and changes	❌	❌	✔️	✔️	✔️	✔️link
Link functions and types to actual code	❌	❌	❌	✔️link	❌	❌
Acknowledgment / Credits with contributors and maintainers	❌	❌	✔️atEnd	✔️	❌	❌
Release Page (by versions)	❌	❌	✔️topRight	✔️	✔️	✔️
Warning/Errors/Undefined behavior	❌	❌	✔️atEnd	✔️bottom	❌	❌
How to use this docs	❌	❌	❌	❌	✔️	✔️link
Documentation conventions	❌	❌	❌	✔️	✔️	✔️link
Troubleshooting guide 😅	❌	❌	✔️	❌	✔️	✔️ atEnd
uBlas Fundamentals 🤐	❌	❌	❌	✔️	✔️	✔️link
Contribution guide(to docs)	❌	❌	✔️link	✔️	✔️	✔️link
Dark Mode 😅	❌	❌	❌	❌	❌	❌
Pitfalls 🤔	❌	❌	✔️link	❌	❌	❌
Permalinks	❌	❌	❌	✔️	✔️	✔️link
Dictionary search / indexing	❌	❌	✔️	✔️	✔️	✔️python
Function search / indexing	❌	❌	✔️link	✔️	❌	✔️link
Coding Standards 🤐	❌	❌	✔️	❌	✔️link	✔️
Quick Search	❌	❌	✔️	❌	✔️	✔️link
Versioning of documentation	✔️	✔️link	✔️	❌	✔️	✔️ link
Good Formatting 😅	❌	✔️	❌	✔️	✔️	✔️
Unsupported Modules 🙄	❌	✔️	✔️link	✔️	✔️	✔️
See Also / Further Reading	❌	❌	✔️link	✔️	✔️	✔️link
Separating every container docs	❌	❌	✔️	✔️
Related links at the end of each file	❌	❌	✔️	✔️
Compilation log if needed in examples	❌	❌	✔️	❌
Future improvements	❌	❌	✔️	✔️
Why (Case studies, why we need it ?, some refs)	❌	❌	✔️	❌