Improved docs

[arjunattam]

Documentation

• 1. Introduction.md
• 2. Core concepts.md
  • Contexts, pages and frames
  • Evaluation
    • Node vs Page execution context
    • Object & element handles
  • Selectors
  • Auto-waiting
• 3. Input.md
  • Forms
  • Text
  • Checkboxes
  • Selects
  • Clicks
  • Files
  • Keys & Shortcuts
• 4. Emulation.md
  • User agent
  • Viewport, color scheme
  • Devices
  • Locale & Timezone
  • Geolocation
  • Permissions
• 5. Network.md
  • Navigation & load
  • Waiting for navigation
  • Handling downloads
  • Network events
  • Mocking network
  • Aborting requests
• 6. Scraping and verification.md
  • Evaluating JavaScript
  • Capturing screenshot
  • Page events
  • Handling exceptions
• 7. Selector engines.md
  • Built-in engines
  • Custom engines
• 8. Test runners.md
  • Jest
  • Mocha
  • Karma
  • Jasmine
  • Jasmine
  • Storybooks
• 9. Continuous integration.md
  • Docker
  • Git Hub
  • Azure Pipelines
  • Travis CI
  • CircleCI
  • AppVeyor
  • Troubleshooting

---

Since Playwright was open sourced, we've received incredible feedback from the community and that has had a huge influence on the API design. To make this API more accessible to a larger audience, we plan to invest in better documentation along with the v1 release. This will be a continuous effort, and this issue is a means to put a stake in the ground.

Content

Structured as navigation sidebar of the upcoming documentation website. Feel free to suggest edits/improvements - this is an evolving list.

• Introduction
  • Getting started [includes local, GH Action, basic examples that are broadly applicable: goto/navigate -> click -> evaluate]
  • FAQs
  • Community showcase
• Guides [with inline code for explanations, and larger snippets with <details>]
  • Working with elements - @arjun27, @dgozman [including resolution of ElementHandle - describe what we have]
  • Page navigation and loading - @dgozman
  • Waiting for events/signals [to be linked from pw:hints callout for waitFor] - @arjun27
  • Verifying execution: with screenshots, console logs, pageerror - @yury-s
• API reference
  • Release notes / Changelog
  • { ...List of classes }

Infra

• Docs website @aslushnikov

[mxschmitt]

The supported operating systems would be quite helpful. So which minimum version of Windows, MacOS etc. is required and why we don't support every MacOS version.
Ref: #1901 #1535

• Minimum Node.js version
• Minimum NPM version
• Minimum Memory recommendation ~150MB per browser maybe?
• Minimum OS version (Win, Mac, Linux)
• Detailed report of which libs are required on which operating systems

[arjunattam]

Closing this for now - we have the first set of docs out. We can take up specific improvements in subsequent issues.