59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
---
|
|
layout: post
|
|
published: true
|
|
author: hanez
|
|
author_email: hanez@fun-lang.xyz
|
|
author_url: https://hanez.org
|
|
noToc: false
|
|
title: Announcing the Fun API Documentation
|
|
description: A new API documentation hub is now available at fun-lang.xyz/api to explore the Fun VM internals and get contributors started faster.
|
|
date: 2026-05-01
|
|
date_updated: 2026-05-06
|
|
categories:
|
|
- news
|
|
- docs
|
|
- project
|
|
tags:
|
|
- fun
|
|
- api
|
|
- documentation
|
|
- vm
|
|
- developers
|
|
- contributors
|
|
---
|
|
|
|
We are excited to announce that the official Fun API documentation is now live at:
|
|
|
|
- [https://api.fun-lang.xyz/](https://api.fun-lang.xyz/){:class="ext"}
|
|
|
|
This new documentation hub is intended to make it easier to understand the internals of the Fun Virtual Machine (VM) and related components. It serves as a central entry point for participants, contributors, and anyone interested in building on top of Fun.
|
|
|
|
This is actually a work in progress, and we are continuously improving and expanding it.
|
|
|
|
### What you can expect to find:
|
|
|
|
- VM internals and module overviews.
|
|
- Detailed API references generated from the source.
|
|
- Cross-links to examples, libraries, and relevant parts of the codebase.
|
|
- A consistent structure designed to help you discover how things work under the hood.
|
|
|
|
### Who is this for?
|
|
|
|
- New contributors looking for a starting point.
|
|
- Power users exploring advanced capabilities of the Fun VM.
|
|
- Researchers and curious minds wanting to understand implementation details.
|
|
|
|
### How to get involved
|
|
|
|
- Browse the API docs at [https://api.fun-lang.xyz/](https://api.fun-lang.xyz/){:class="ext"} and send feedback.
|
|
- Open issues and ideas in our Git repository: [https://git.xw3.org/fun/fun](https://git.xw3.org/fun/fun){:class="git"}.
|
|
- Join the discussion: [https://fun-lang.xyz/community/](https://fun-lang.xyz/community/).
|
|
- Reach out directly: [hanez@fun-lang.xyz](mailto:hanez@fun-lang.xyz){:class="mail"}.
|
|
|
|
This is just the beginning — we will keep iterating on structure, coverage, and examples. If you notice gaps or have suggestions, please let us know.
|
|
|
|
Happy hacking!
|
|
|
|
Johannes Findeisen (hanez) — [hanez@fun-lang.xyz](mailto:hanez@fun-lang.xyz){:class="mail"}
|
|
|
|
UPDATE: The api documentation moved to [https://api.fun-lang.xyz/](https://api.fun-lang.xyz/){:class="ext"}.
|