Adobe Firefly Services API Documentation

This repo contains Firefly Services API documentation.

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

Deployment

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