Swashbuckle.AspNetCore icon indicating copy to clipboard operation
Swashbuckle.AspNetCore copied to clipboard

Would a ReadTheDocs site be interesting?

Open tillig opened this issue 7 years ago • 8 comments

The README is getting to be pretty long and I noticed that a lot of questions I've seen come up in the issues list might be self-answered if there was a more dedicated documentation site like something hosted on readthedocs.io. A site like that could be easier to search and navigate, and tying it into the build would mean if you need to update docs it'd be just as simple as committing a change to the README like it is now.

If it would be interesting, I'd be happy to set up a pull request with a base configuration for the docs and start moving some of the README content over. The only thing you'd have to do is follow their guide to sign up for an account and attach the repo so they can start building on each commit. (You need to do that so you own it.)

After that, any time you need to update your doc site, you just update the restructuredText in the docs and commit. It's pretty simple; I run the doc site for Autofac and write most of that doc, too, if you want an example.

tillig avatar Jun 15 '17 00:06 tillig