Skip to content

Google Season of Docs 2024 Proposal

Jump to bottom
Priyansh Garg edited this page Apr 2, 2024 · 6 revisions

Improve Nightwatch.js Guide and API docs

About Nightwatch.js

Nightwatch.js is an open-source integrated testing framework powered by Node.js and using the W3C Webdriver API. It provides a complete testing solution and can be used for a wide range of testing needs, including:

  • End-to-end testing of web applications and websites on both desktop and mobile devices.
  • Component testing in isolation (React / Vue / Storybook / Angular).
  • Unit testing, Visual Regression testing, Accessibility testing, and API testing. * Native mobile app testing on Android & iOS.

Nightwatch.js is widely used by Front-End developers and QA Teams, and has built an active and engaging community around it with around 1.5k community members on Discord server, 11.7k GitHub stars and 1.3k forks.

About our project

Problem

Nightwatch.js is widely used by Front-End developers and QA Teams and in the past few years Nightwatch.js has managed to deliver a lot of new features, which were welcomed positively by the community, but the documentation was not able to keep pace with it. Due to this, the current documentation of Nightwatch.js is outdated and incomplete, with many new features not documented properly, which makes it difficult for users to get started with the project and for contributors to understand how to contribute effectively.

Our project's scope

With Google Season of Docs, the main goal of this project is to improve the documentation for NightwatchJS to make it more accessible and useful to users and contributors. Specifically, we aim to achieve the following goals:

  • Ensure that the documentation is accurate and up-to-date
  • Expand the existing documentation to cover more topics and use cases
  • Fill gaps in the current documentation to provide a comprehensive overview of the project
  • Improve the organization and structure of the documentation to make it easier to navigate
  • Develop a style guide to ensure consistency across all documentation

Timeline

The project will take approximately 5-6 months to complete.

Dates Action Items
May Research and review the existing documentation to identify areas that need improvement.
June Start with updating Nightwatch API docs to ensure that they are accurate and up-to-date with all examples working.

Project Budget

Clone this wiki locally