Consider setting up GitHub wiki

[drizzle042]

I think we should consider putting the documentation on the repo’s GitHub wiki section for easier navigation.

[W4RH4WK]

I'd advise against moving (or duplicating) the documentation to the GitHub wiki as the wiki is not necessarily in sync with the main repository.

If you download an older version of libenvpp, you now get the corresponding documentation for it.

Maybe reorganizing the main README, or splitting it up could improve the user-experience.

[drizzle042]

as the wiki is not necessarily in sync with the main repository.

What do you mean by this? I don’t see a Wiki to begin with.

Improving readers experience is the main goal of creating a wiki. With a mandate that every code change (via pull request or any other means) should be properly documented. Spdlog, Drogon and many other packages that have their documentation on GitHub use GitHub wiki over a ReadME file. That’s why GitHub wiki was put for repositories.

Having a GitHub wiki is never a bad idea.

[W4RH4WK]

What do you mean by this?

What I meant is that while the repository usually contains all previous versions in an organized manner (tags and branches), the GitHub wiki only focuses on the most recent version. For instance, say you have to use spdlog v1.6.1, obviously you'd like to read the documentation for that specific version. But when you go to the wiki, you can't simply select v1.6.1 and read the documentation as it was at the point in time where v1.6.1 got released.

You can view an older version of a wiki page (example), but you don't know whether this one relates to v1.6.1. Also, every link on the wiki will take you back to the up-to-date version.

Neither does a GitHub release (example) provide a copy of the corresponding version of the wiki.

For spdlog, I assume the documentation in the wiki currently refers to v1.x as this appears to be the main branch. But there is also a v2.x branch -- the major version difference suggests that the API has changed substantially. Where do I find the documentation for that branch?

I hope this illustrates my point sufficiently.

[drizzle042]

Well then GitHub pages will do the trick then. With a GitHub action for new releases. My point is that using just a ReadME file gives poor user experience. Consider giving this an enhancement label. Great project by the way.