README.md

DocsProject

This repository contains Groovy source code for two classes:

• Light
• MyCoolLight

It also contains the class TestApp that shows basic usage of these classes.

Your assignment is to document this project by updating the docs/ProjectDocumentation.md file. The audience for this documentation will be fellow developers who want to do cool things with the lights.

Specific topics covered by the documentation should include:

• How to install and run the application (hint: it requires Groovy and Gradle, and utilizes the application Gradle plugin)
• What the Light and MyCoolLight classes do and how to use them
• Documentation for the public APIs in the Light and MyCoolLight classes, including parameters and return types

You should also update the TestApp file to show example usage that developers can reference and try themselves.

Submission process:

• Create a PR to this repository targeted at the main branch with your docs and example changes.

Other notes:

• The documentation page stub is a Markdown file, but Markdown is not required. You are free to choose the format of your choice, so long as it is text-based and markdown-like (e.g., Asciidoc and reStructuredText or OK too - just be sure to change the file extension).
• You are free to use any auto-generated documentation tooling for class-level documentation, if you so choose. If any such tooling is added, it should be possible to build the generated artifacts using Gradle.