Public Assets Repository

A dedicated repository for storing and serving high-quality assets (images, videos, GIFs) that can be referenced by other repositories within the organization.

Purpose

This repository solves the following challenges:

• Prevents bloating other repositories with large media files
• Provides a centralized location for all shared assets
• Reduces clone/download size for developers working with the primary code repositories
• Ensures persistence of assets referenced in documentation

Usage

Storing Assets

Assets should be organized according to the following structure:

/{repository-name}/{asset-name}

Example:

/mcp-atlassian-server/introduce.gif

Referencing Assets

Reference assets in your documentation using raw GitHub URLs:

!Description

Example:

!Introduction

Guidelines

1. Only commit media assets to this repository - no source code or text files (except this README)
2. Use descriptive filenames that indicate the asset's purpose
3. Optimize assets before uploading to minimize file size without sacrificing quality
4. Archive old assets in an "archived" directory if they're no longer needed but might be referenced

Benefits

• Developers can clone code repositories quickly without downloading large assets
• Documentation remains intact with all assets properly linked
• Assets can be updated without modifying reference repositories
• Avoids GitHub's file size and repository size limitations

Contributing

When adding new assets:

1. Create a folder with your repository name if it doesn't exist
2. Add your optimized assets inside that folder
3. Use meaningful filenames that describe the asset's purpose