Breeze Seas Documentation

You are browsing the Breeze Seas documentation portal. The generated Javadoc reference is available here.

Getting Started

This portal provides one place to access team-written project guidance and the generated API reference. Start with the wiki for process and design notes, then use the Javadocs when you need source-level detail.

Open the project wiki

Official Guides

Living project documentation is maintained in the repository wiki and issue tracker. These resources are the best place for onboarding, architecture notes, decisions, and active work context.

Project Documentation Project Wiki Source Repository

Work Tracking Issue Tracker Pull Requests

API Docs

API documentation is generated from the codebase and published under the Javadoc directory for GitHub Pages. Use it for packages, classes, search, and symbol indexes.

Topics Javadoc Home Using the Javadocs

Classes All Classes Package Summary

Indexes Index Pages Search

License & Legal

Breeze Seas is released as free software under a strong copyleft license: GNU GPL v3 or later. That keeps redistributed and modified versions open under the same license family and provides a clear no-warranty notice.

Project License Repository License File GNU GPL v3 Text

Legal Notes No Warranty Disclaimer Source Availability

Breeze Seas documentation portal for GitHub Pages. Human-authored guidance lives in the wiki, generated reference lives in docs/javadoc/, and the project is licensed under GPL-3.0-or-later.