Create documentation website

[MessiasLima]

Description

Create the first version of the some documentation website using Zensical and publish it under some.appoutlet.dev.

• Set up a new Zensical site with the appropriate configuration

• Write documentation covering:

  • What the library is for (test data generation for Kotlin)
  • How to install (Maven Central coordinates)
  • How to use (basic some<T>(), configuration, custom factories)

• Simplify the README to a minimal intro that directs readers to the website for full documentation

• Publish the site at some.appoutlet.dev (DNS, hosting, deployment)

• References

  • Zensical docs
  • some.appoutlet.dev

Scope

• Scaffolding a Zensical project for the documentation site
• Writing the initial pages (intro, installation, usage, configuration)
• Simplifying the README to defer to the website
• Configuring DNS and deploying to some.appoutlet.dev
• Out of scope: API reference generation, multiple versions, blog

Acceptance criteria

• The website is live at some.appoutlet.dev
• The site explains what the library is for, how to install, and how to use it
• The README is simplified and directs users to the website
• The site is built with Zensical