Compfeed

Quickstart

Go from a new account to your first reviewed Manifest for the Button example.

Go from a new account to your first Manifest: a documented component, produced by a process your team agreed on. About twenty minutes.

For the person setting up Compfeed. If somebody invited you to a team instead, see If you were invited.

One example runs throughout. A design system team adds a loading state to its Button component.

If you were invited

Somebody else has already set up the organization, the team and the process. You do not need the steps below.

  1. Open the invitation email and accept it. Sign in with the address the invitation was sent to; another address will not find the organization.
  2. Open the team you were added to and find the component you are contributing to. If it is not there yet, ask a team admin or editor to add it.
  3. Go to Link the widget to the Button and work forward from there.

Your role decides what you can change. Admin and Editor can tick checks and edit a contribution; Viewer can read it. See Organization, teams and members.

Before you begin

A Figma account with edit access to a file you can work in. No paid plan is needed to finish this guide.

Create your account

Sign up at app.compfeed.com.

You can use an email address and password, a magic link, Google or Microsoft. See Profile and security for all the options.

Set up your organization

Your organization holds the teams that work on your design system.

  1. Enter an Organization name.
  2. Enter a Workspace URL, using lowercase letters, numbers and hyphens.
  3. Decide whether to tick I agree to share my AI usage data to help improve the product. You can change this later under Settings → Organization.
  4. Continue.

Create your first team

On Create your first team, name it after the group that owns this part of the design system.

Compfeed also creates a team called Core, your central component library. An admin of the Core team holds the organization-level admin powers, so it matters who you put there.

Invite the people you work with

On Invite into your organization, add email addresses and give each person Admin, Editor or Viewer. Choose Skip for now to do this later.

Only Admins and Editors use a paid seat, so adding Viewers costs nothing. See Organization, teams and members.

Start from the built-in process

A process is the set of phases every contribution moves through. Each phase holds checks, which people check off as they work.

  1. Open your team and go to Processes.
  2. Open GET A HEAD START.
  3. On the Use Our Process card, choose USE TEMPLATE.

The editor opens with a four-phase process already written: preparing the design, consolidating it, aligning with development, and documentation. Read it, change what does not fit, then choose Publish.

A process only reaches contributions once you choose Publish. Until then the editor shows draft saved and nobody else is affected.

See Create a process to write your own, or A detailed example process for a fuller one to borrow from.

Add the Button to Compfeed

  1. Open your team and go to Components.
  2. Choose Add component.
  3. Name it Button.
  4. Pick the process you published.

The Button appears on your Dashboard, in the first phase. Creating a component needs Admin or Editor on that team.

Designers work from the Compfeed widget, beside their design in Figma.

  1. In Figma, open the file where the Button lives.
  2. Add the widget from the Figma Community page.
  3. Select the widget, open the cogwheel, and connect it to your Compfeed account.
  4. Pick your team, then the Button.
  5. Choose SELECT FIGMA COMPONENT and select the page, frame, section or component the Button lives in.

The widget now shows the Button's phases and checks. Full detail is in Set up the widget and Link the widget to a component.

Work through the checks

Add the loading state in Figma, ticking checks in the widget as you finish them. Checks sync with the web app both ways.

Then open the Button in Compfeed, choose PLAYGROUND, and write down what you decided and why. Those notes are what the Manifest is built from, so write them as you go. See Work in Playground.

Phases do not advance on their own. When a phase is done, select the next one.

Generate the Manifest

  1. Open the Button and choose MANIFEST.
  2. Choose Ready to Generate Documentation.

Compfeed drafts the documentation from your notes, the checks you completed and the images in the contribution.

The draft is a starting point. Read it and correct it yourself: Compfeed does not check whether it is accurate.

Expected result

A published process, a Button following it, a Figma widget in step with the web app, and a Manifest you have reviewed. Anyone on the team can see which phase the Button is in and what is still open.

If something doesn't work

See Troubleshooting. The two most common: the widget shows a banner saying a new version is available (update it), or the widget shows Where is the checklist? (link it).

What's next

Create a process

Introduction

Give every contribution to your design system the same clear process, and see where each one stands.

Create a process

Define the phases and checks every contribution on your team moves through.

On this page

If you were invitedBefore you beginCreate your accountSet up your organizationCreate your first teamInvite the people you work withStart from the built-in processAdd the Button to CompfeedLink the widget to the ButtonWork through the checksGenerate the ManifestExpected resultIf something doesn't workWhat's next