Readme.com documentation

[StarlessNights]

Correct me if I'm wrong, but it looks like the documentation sources are not in this git repository. Only in readme.com.

To me this is a bit suspicious.

What license is the documentation under? Who holds the copyrights? Is there a source repository for it somewhere? What guarantee is there that it stays available?

There is a "Suggest Edits" button on the site but I don't really feel comfortable contributing to the documentation under these conditions.

I would consider it a norm to have /docs directory in the main code repository with e.g. markdown files inside, and generate the HTML documentation from there.

[snipe]

We used to store docs in the repo, but constantly building them on releases to make them publicly available, hosting them, etc was a hassle. Readme.io offers an API explorer that developers find very useful in playing with the Snipe-IT API, and we just couldn't find anything open source that could compare.

Unfortunately, exporting docs to PDF via Readme.io requires their enterprise plan, and that's $2k/month.

[snipe]

At the end of the day, we sacrificed the /docs method to make it easier for us, and to provide a better UI experience for users and devs. If something should ever happen to Readme.io, we can scrape old versions and get something viable online shortly, then rethink what to do next. This way just works better for us. I understand if that makes you uncomfortable. The only real answer I have is that you've gotta trust us. This is a 10 year old project with a business backing it. We're not just going to leave everyone in the lurch.

[StarlessNights]

Thanks for your answer. Yeah I understand that migrating the docs wouldn't perhaps be smart use of our time, and I don't think that there's any malice involved, but I would expect a clarifying note somewhere. A note making it clear that these docs aren't under AGPL.

Speaking of the API explorer, would it be possible to have at least the openapi spec in repo? There have been feature requests for snipe-it serving this document, and in this event it would need to be in the repo anyway.

[snipe]

We have that on readme.io as well, since they natively support it: https://snipe-it.readme.io/openapi/