Development Guide

Hubzilla & Neuhub Developer Documentation

A collection of documents and a wiki for Hubzilla developers.

We also included references to (streams) and Forte, since the projects are similar and have compatible licenses. This may be useful for porting code between platforms, and also to see how things are done on different platforms. This also includes documentation for various addons, widgets, and themes.

The main components will be:

• Developer Documentation Wiki
• Hubzilla Codebase Wiki
• Articles (typically how-to and answers to questions)
• Fediverse Channel (change log and for making announcements) hubzilla@development.guide

Non-developer documentation will be located elsewhere.

This is something we are building over time. As we create new things and update existing code, we will build the related pages here. If you are a Hubzilla developer and would like write access to the wiki, send a DM to scott@loves.tech.*

Codebase Wiki

The codebase wiki has some unique rules. It can only contain wiki entries that are either URLs or files in the repositories, and it must include the path without the domain name.

For example, if we were to create an entry for the Admin Summary Page, the wiki entry for the URL would be called admin and its related module would be Zotlabs/Module/Admin.php using the same capitalization as the file names.

For documentation that is not related to the URL or the filename, that would go into the Developer Documentation Wiki instead. You can and should link between the two wikis.

You can use existing pages as examples of how to format your contributions. If we get many contributors, we may add a style guide and templates.

Project Management

We will also be integrating project management features from Build Together / Dev powered by WisTex Catalyst.

Once added, you will be able to see related tasks for each URL or file. Launching soon!

Work in Progress

We know this is awkward, but it is easier to create the links now than to go back and try to find all of the references to the file or URL later. As a Hubzilla developer, you can help us fix that by adding to the wiki

Other Projects Invited

We have room on this server for other fediverse and open source projects that are looking for a place to put their developer documentation. If you are interested, please send a DM to scott@loves.tech.* We also have other domains, or we can help you host this software on your own domain.

We are using Hubzilla, which would allow you to create a fediverse-enabled wiki with collaboration features.

• People can follow your updates over ActivityPub, Diaspora, or Zot protocol. Bluesky is supported if you use Bridgy Fed.**
• You can grant other Hubzilla, (streams), Forte, or OpenWebAuth users the ability to edit webpages, wiki, or articles.
• The documentation can be created in HTML, BBCode, or Markdown. Or a mix of Markdown with HTML on the same page.
• Once we launch the project management features, you can optionally use those as well.

Once we have other projects on this server, we will change this home page.

Footnotes

*This address does not accept email; it must be a direct message (DM) from a fediverse platform.

**If you are allergic to any of the above protocols, you don't have to enable them for your channel. They will be blocked if not enabled. Except for Zot protocol, which cannot be disabled.