search

jimporter / mettle

A C++20 unit test framework
https://jimporter.github.io/mettle
BSD 3-Clause "New" or "Revised" License
122 stars 12 forks source link

Add doc/Readme.md with TOC to make documentation easier to access? #5

Closed martinmoene closed 10 years ago

martinmoene commented 10 years ago

Documentation available and access to it may be improved by providing a table of contents in a doc/Readme.md. This file may also contain the current content of index.md.

See for example doc at Catch.

jimporter commented 10 years ago

I'm not sure I understand why a README in doc/ would help. The doc/ dir gets built and put onto GitHub pages, where there's already a table of contents available.

martinmoene commented 10 years ago

Ah sorry, didn't realise that the http://jimporter.github.io/mettle/ reflects the documentation in the doc directory. Then a doc/Readme.md may be (only) useful to redirect the casual code browser to the GitHub page.

jimporter commented 10 years ago

I think if I added doc/README.md, MkDocs would build that file and push it to GitHub pages, which I'd rather avoid.

I've been thinking about updating the main readme once I finish up caliber, so maybe I can make it more obvious then.

martinmoene commented 10 years ago

I better familiarise myself with GitHub pages then...

There's little (nothing) to 'complain' about the visibility of the documentation from the main readme ;)

jimporter commented 10 years ago

For what it's worth, I moved the link to the docs to be the first thing in the main readme, and also made it bold so it stands out more: 65e1e382b3502c6fb5fa4cff85c3906d6390f03c