Introducing builtwithhare.org August 22, 2025 by Drew DeVault

One of the Hare community’s shared values is a belief in the importance of good documentation. haredoc is a great and accessible resource both for writing and reading documentation – you can just comment your code to produce docs, and reading them is just a few keystrokes away in your terminal emulator.

$ haredoc os::create
// Creates a new file with the given mode if it doesn't already exist and opens
// it for writing.
//
// Only the permission bits of the mode are used. If other bits are set, they
// are discarded.
//
// The return value is an unbuffered [[io::file]]. For buffered I/O, see
// [[create_buffered]]. To create a file without opening it, see [[mkfile]].
fn create(
        path: str,
        mode: fs::mode,
        flags: fs::flag = fs::flag::WRONLY | fs::flag::TRUNC,
) (io::file | fs::error);

Docs written with haredoc can also be formatted for the web, and the standard library documentation available here on harelang.org is based on this approach. However, this can only get you so far – publishing haredocs on the web requires having a place to host it, a domain name and some kind of web hosting – and haredocs are not a comprehensive solution for good documentation.

This is why, of course, the standard library’s haredocs here on harelang.org are only a part of our approach to good documentation. We supplement them with our Sphinx docs, as well as the tutorials, specification, and even this blog as additional resources. Not to mention the value in having a home page where we can give you the elevator pitch.

To make these kinds of resources more accessible to the Hare community, and to continue making it as easy and fun as possible for the Hare community to put out good documentation for the things we build, today I’d like to introduce you to builtwithhare.org. The premise is quite simple: if you want a space to put up a website for your Hare project, you can have a subdomain here.

I published documentation for hare-wren here first – at wren.builtwithhare.org – and a few other projects are lined up to get published here once their websites are ready. Want yours to be next? Let us know on the hare-users mailing list. Whether it’s somewhere to put your haredocs, a more complicated website with Sphinx or Hugo or whatever, or even a full-stack web application for some Hare-related web thing – we’re happy to host it.