search

thephpleague / openapi-psr7-validator

It validates PSR-7 messages (HTTP request/response) against OpenAPI specifications
MIT License
523 stars 92 forks source link

Make a tutorial on GH-Pages #1

Open lezhnev74 opened 5 years ago

lezhnev74 commented 5 years ago

As suggested by @frankdejonge we should start a doc website for the package. With explanations, examples, FAQ and get-started examples.

Inspired by https://flysystem.thephpleague.com/docs/

scaytrase commented 5 years ago

Do we have any org style guides or we can do in our way?

frankdejonge commented 5 years ago

There's a generic style, which is here: https://github.com/thephpleague/theme.thephpleague.com

I created my own style for Flysystem using Tailwind CSS.

scaytrase commented 4 years ago

I pushed boilerplate to the gh-pages branch, will try to populate it with something useful

frankdejonge commented 4 years ago

If you decide on a subdomain name, let me know and I'll point the DNS in the right direction.

philsturgeon commented 4 years ago

Stoplight Docs is a free hosted thing, and I think open source projects will get some of the extra features which others are gonna be paying for (like domains, probably).

Yep it's a lot of OpenAPI but also its Markdown documentation. Might be easier than rolling your own.

scaytrase commented 4 years ago

@frankdejonge yea, CNAME would be preferrable, since subfolder breaks links and it's not really convenient to write docs keeping this in mind.

Currently I configured this openapi-psr7-validator.thephpleague.com