Giters

JPenuchot / ctbench

Compiler-assisted variable size benchmarking for the study of C++ metaprogram compile times.

Home Page:https://jpenuchot.github.io/ctbench-docs/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Clearer docs

JPenuchot opened this issue · comments

commented

I'm having a hard time finding a good way to organize the documentation into something that's clear and concise. I'm currently not satisfied by the way JSON configuration values are documented as I feel like users have to dig way too much just to find JSON configuration information.

Additionally, the docs aren't clear about what's internal or not.

I'm leaving this issue here as long as I'm not satisfied with way the docs are presented, any suggestion or critics are welcome.

commented

Note: I'm open to any critic about the docs. Any newcomer having trouble understanding how ctbench works please let me know and I'll do my best to adjust the documentation.