go.olly.garden

Vanity URL service for Go modules in the ollygarden organization.

Overview

This repository provides custom import paths for Go modules under the go.olly.garden domain. It serves HTML pages with go-import meta tags that redirect the Go toolchain to the actual source repositories on GitHub.

Available Modules

The following modules are available under go.olly.garden:

go.olly.garden/bulbs
go.olly.garden/chaff
go.olly.garden/clary
go.olly.garden/dibber
go.olly.garden/fig
go.olly.garden/gaps
go.olly.garden/greenhouse
go.olly.garden/hummingbird
go.olly.garden/loam
go.olly.garden/marigold
go.olly.garden/mulch
go.olly.garden/monsoon
go.olly.garden/nameplate
go.olly.garden/nettle
go.olly.garden/overstory
go.olly.garden/pottingshed
go.olly.garden/raincatcher
go.olly.garden/sage
go.olly.garden/shears
go.olly.garden/tendril
go.olly.garden/trellis

Usage

Import any module using its vanity URL:

import "go.olly.garden/trellis"

Local Development

For local development with private repositories, see DEVELOPMENT.md for setup instructions.

Adding New Modules

To add a new module redirect:

Create a new directory with the module name
Add an index.html file with the appropriate meta tags:

<!DOCTYPE html>
<html>
  <head>
    <meta name="go-import" content="go.olly.garden/MODULE_NAME git https://github.com/ollygarden/MODULE_NAME">
    <meta http-equiv="refresh" content="0; url=https://pkg.go.dev/go.olly.garden/MODULE_NAME">
  </head>
  <body>
    Nothing to see here. Please refer to <a href="https://pkg.go.dev/go.olly.garden/MODULE_NAME">pkg.go.dev</a>.
  </body>
</html>

Replace MODULE_NAME with your actual module name
Commit and deploy the changes

Documentation

Each module’s documentation is automatically available at:

https://pkg.go.dev/go.olly.garden/{module-name}

Contributing

When contributing to this repository:

Use conventional commit messages (e.g., feat: add new module, docs: update README)
Work on feature branches rather than directly on main
Follow the existing HTML structure and patterns for module redirects
Update both README.md and CLAUDE.md when adding new modules

License

Apache License 2.0 - See LICENSE file for details.