Adobe Firefly Services API Documentation

This repo is the central hub repository for Firefly Services API documentation. Each Firefly Services API has its own repository, which is a spoke repository to this monorepo.

Where to ask for help

For contributors

For information on how to contribute and collaborate on the docs, see the CONTRIBUTING.md.

How to develop

For local development, you'll need Yarn:

$ yarn install

Then to develop locally, run:

$ yarn clean
$ yarn dev

For the developer documentation, read the following sections on how to:

• Arrange the structure content of your docs
• Link to pages
• Use assets
• Set global Navigation
• Set side navigation
• Use content blocks
• Use Markdown

Or review the README on GitHub for complete details about the microsite theme.

How to test

Lint status checks run on all PRs before merging.

Configured linters can also run locally (requires Docker):

yarn lint

NOTE If you cannot use Docker, you can install the linters separately. In .github/super-linter.env, see which linters are enabled, and find the tools being used for linting in Supported Linters.

To check internal links locally:

yarn test:links

To build and preview locally:

yarn start

AI Hub rules CLI (hubrules)

Use the hubrules CLI to borrow Cursor rules from this central hub repo into any spoke repo. It clones the hub into .hub-rules and symlinks rules into .cursor/rules.

Install

From this repo:

$ yarn install
$ yarn hubrules --help

Or link globally (recommended):

$ npm link
$ hubrules --help

Commands

Initialize a spoke repo with a link to this central hub repo (required once per repo):

$ hubrules init --hub-url <git-url> [--branch main] [--path .hub-rules] [--force]

Example to the Firefly Services hub:

$ hubrules init --hub-url https://github.com/AdobeDocs/ff-services-docs.git --branch main --path .hub-rules --force

List available hub rules:

$ hubrules list

Use a hub rule (creates a symlink in .cursor/rules to the agent's rule file). Using the --all flag creates symlinks for all agent rules in the hub (opt-in bulk link):

$ hubrules use <agent-name> [--force] [--all]

Remove a borrowed rule:

$ hubrules remove <agent-name> [--force]

Remove all borrowed rules (opt-in bulk remove):

$ hubrules remove --all [--force]

Show current borrowed rules:

$ hubrules status

Notes

• The config file .hub-rules.json is created in the spoke repo root.
• use accepts names with or without the .mdc suffix.
• Existing non‑symlink or different symlink → error unless --force.
• --force overwrites existing rule files.

Deployment

Deployments are done by the FFS docs development team. Reach out to schedule content deployments to stage and production.