Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/artemis-development-group/artemis/llms.txt

Use this file to discover all available pages before exploring further.

Branches are the core organizational unit of Artemis — self-contained community spaces where members submit posts, leave comments, and discuss topics around a shared theme. Each branch has its own moderators, rules, sidebar, stylesheet, and flair settings. This page covers everything you need to know about creating and configuring branches, browsing branch listings, subscribing, and building multi-branch feeds.

​
Branch name rules

Branch names must match the pattern [A-Za-z0-9][A-Za-z0-9_]{2,20} — between 3 and 21 characters, starting with a letter or digit, and containing only letters, digits, and underscores.

​
Creating a branch

1

Navigate to the creation form

Go to /branches/create. You must be logged in to create a branch.
2

Choose a name

Enter a unique branch name. Names are case-insensitive and permanent — you cannot rename a branch after creation.
3

Set the branch type

Select who can view and submit content. See Branch types below for a full breakdown.
4

Add a description

Write a public description (up to 500 characters). This appears in search results and the branch header.
5

Submit

Click Create Community. You are automatically made the first moderator with full permissions.

​
Branch types

Artemis supports several branch visibility and access modes, controlled by the type field on the branch model.
public — Anyone can view posts and submit content. The default type for new branches. Branches appear in listings and search results.
The private, gold_only, and employees_only types are all considered private types — content in these branches is not accessible unless you are an approved contributor or moderator.

​
Branch listings

Artemis provides several global branch listings you can browse to discover communities.
URLDescription
/branches/popularBranches ranked by current subscriber count and activity
/branches/newRecently created branches
/branches/defaultThe set of default branches shown to logged-out users
/branches/goldBranches requiring gold membership
/branches/searchFull-text search across all branch names and descriptions
Your personal branch listings (branches you moderate or contribute to) are at:
  • /branches/mine/subscriber — branches you subscribe to
  • /branches/mine/contributor — branches you are an approved contributor of
  • /branches/mine/moderator — branches you moderate

​
Configuring a branch

Moderators access branch settings at /r/:branchname/about/edit. Key settings include:
  • Title and description — displayed in the branch header and search results
  • Public description — short text shown in listings (up to 500 characters)
  • Submission text — shown to users before they submit a post (config/submit_text, up to 1,024 bytes)
  • Sidebar — markdown content shown in the sidebar (config/sidebar, up to 5,120 bytes)
  • Stylesheet — custom CSS applied to the branch (config/stylesheet, up to 128 KB)
  • Link type — controls whether the branch accepts link posts, text posts, or both (link, self, or any)
  • Over-18 — marks the branch as NSFW
  • Suggested comment sort — default sort applied to comment threads
  • Wiki mode — whether the wiki is disabled, open to all users, or restricted to moderators and approved wiki contributors

​
Subscribing to branches

Logged-in users can subscribe to any public or restricted branch. Subscribed branches appear in the user’s front page feed. The subscription limit is 50 branches for standard accounts and 100 for gold accounts. To subscribe, click Join on the branch header, or send a POST to /api/subscribe.

​
Multi-branch feeds

Multis let you combine multiple branches into a single feed without subscribing to each one individually. A multi lives at /user/:username/m/:multipath and can be accessed by anyone if set to public, or kept private for personal use. You can also manage your own multis at /me/m/:multipath. 
# Example multi URL
/user/alice/m/science

# Manage your own multi
/me/m/science
The multi API endpoints are at /api/multi/*multipath for creating, reading, updating, and deleting multis, and at /api/multi/*multipath/r/:srname for adding or removing individual branches.

Wiki

Each branch has its own wiki for documentation and community resources.

Flair

Set up user flair and link flair templates for your branch.

AutoModerator

Automate moderation using YAML rules stored in the branch wiki.

Moderation

Manage moderators, ban users, and handle the moderation queue.

Build docs developers (and LLMs) love

Get started for freeTalk to us