Giters

bocoup / wpt-docs

A clone of the web-platform-tests project to collaborate on documentation reorganization

Home Page:https://wpt-docs.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Describe capabilities in terms of contributor goals

jugglinmike opened this issue · comments

commented

Some of the content on authoring tests is organized according to the way it has been implemented. For example,

  • instructions on how to write tests that run in HTTPS are located under "File Name Flags"
  • instructions on how to control response headers are located in the wptserver documentation

While logical, this framing may obscure information from first-time contributors since they must know how a feature is implemented in order to know where to look for its documentation.

Relocate the content to locations which describe contributor goals (e.g. "Controlling how resources are interpreted" and "Controlling network responses").