search

bocoup / wpt-docs

A clone of the web-platform-tests project to collaborate on documentation reorganization
https://wpt-docs.readthedocs.io
Other
1 stars 0 forks source link

[docs] Integrate wptserve documentation #9

Closed jugglinmike closed 5 years ago

jugglinmike commented 5 years ago

Relocate instructions that are specifically geared towards test authors to the "docs" directory. Persist API documentation in its current location and configure Sphinx to include relevant aspects in the generated website.

This is an rough cut of a new structure for the wptserve documentation. I'll admit that the organization of content about "pipes" is a little too focused on implementation details. gh-3 identifies this same problem in some of the existing documentation; if we can agree on this solution at a high-level, then I'd be happy to address that issue with more fine-grained restructuring in a follow-up patch.

Depends on gh-7.

jugglinmike commented 5 years ago

Thanks for the review, @zcorpan! Rebased and merged to master at commit 065214c400aee7752a46afc61f701664c44842a8