Skip to content

Commit 094fa39

Browse files
committed
Refactor code structure and remove redundant sections for improved readability and maintainability
1 parent d5fcb43 commit 094fa39

22 files changed

Lines changed: 220 additions & 3 deletions

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,27 @@ keywords:
1515
- finops
1616
---
1717

18-
## Overview
18+
<p align="center">
19+
<img src="assets/branding/logo/logo-256.png" alt="Agentic Accelerator Framework" width="200">
20+
</p>
21+
22+
<h1 align="center">Agentic Accelerator Framework</h1>
23+
24+
<p align="center">
25+
<strong>GitHub Advanced Security + GitHub Copilot Custom Agents + Microsoft Defender for Cloud</strong><br>
26+
<em>Shift-left security and compliance across Security, Accessibility, Code Quality, and FinOps</em>
27+
</p>
1928

20-
**Agentic Accelerator = GitHub Advanced Security + GitHub Copilot Custom Agents + Microsoft Defender for Cloud**
29+
<p align="center">
30+
<a href="#agent-inventory-15-agents"><img src="https://img.shields.io/badge/agents-15-blue" alt="15 Agents"></a>
31+
<a href="#ci-cd-workflows"><img src="https://img.shields.io/badge/SARIF-v2.1.0-green" alt="SARIF v2.1.0"></a>
32+
<a href="https://github.com/devopsabcs-engineering/agentic-accelerator-framework/actions"><img src="https://img.shields.io/badge/CI%2FCD-7%20workflows-orange" alt="7 CI/CD Workflows"></a>
33+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="MIT License"></a>
34+
</p>
2135

22-
*(GitHub preferred; Azure DevOps first-class citizen)*
36+
---
37+
38+
## Overview
2339

2440
The Agentic Accelerator Framework provides a repeatable, org-wide approach to shifting security and compliance left using custom GitHub Copilot agents. It covers four domains — Security, Accessibility, Code Quality, and FinOps — with SARIF-based CI/CD integration across GitHub Actions and Azure DevOps.
2541

assets/branding/BRANDING.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Agentic Accelerator Framework — Branding Guide
2+
3+
## Logo
4+
5+
The framework logo features a gear/cog at center surrounded by orbital loops in deep blue (#1B5E90) and cyan (#2DD4BF), symbolizing the agentic automation and accelerating cycle of shift-left security.
6+
7+
### Color Palette
8+
9+
| Color | Hex | Usage |
10+
|-------|-----|-------|
11+
| Deep Blue | `#1B5E90` | Primary brand color, left orbital loop |
12+
| Cyan | `#2DD4BF` | Accent color, right orbital loop |
13+
| Dark Navy | `#0D1117` | Dark backgrounds, social preview |
14+
| Dark Gear | `#1A2332` | Central gear element |
15+
16+
### Logo Files
17+
18+
All logo variants are in `assets/branding/`:
19+
20+
```text
21+
assets/branding/
22+
├── agentic-accelerator-framework-logo.png # Original source (1024×1024, white bg)
23+
├── logo/
24+
│ ├── logo-transparent.png # 1024×1024, transparent background
25+
│ ├── logo-1024.png # 1024×1024, transparent
26+
│ ├── logo-512.png # 512×512, transparent (org avatar)
27+
│ ├── logo-256.png # 256×256, transparent (README)
28+
│ ├── logo-128.png # 128×128, transparent (inline)
29+
│ ├── logo-64.png # 64×64, transparent (icon)
30+
│ └── logo-32.png # 32×32, transparent (tiny)
31+
├── social/
32+
│ ├── social-preview-1280x640.png # GitHub social preview
33+
│ └── readme-banner.png # README header (800×200)
34+
├── favicon/
35+
│ ├── favicon.ico # Multi-size ICO (16, 32, 48)
36+
│ ├── favicon-16x16.png # Web favicon
37+
│ ├── favicon-32x32.png # Web favicon
38+
│ ├── favicon-48x48.png # Web favicon
39+
│ ├── favicon-180x180.png # Apple touch icon size
40+
│ ├── favicon-192x192.png # Android icon
41+
│ ├── favicon-512x512.png # PWA icon
42+
│ └── apple-touch-icon.png # iOS bookmarks (180×180)
43+
└── workshop/
44+
├── workshop-logo-200.png # Workshop header logo
45+
└── workshop-header.png # Workshop header with text
46+
```
47+
48+
## Where to Use the Logo
49+
50+
### Framework Repository (this repo)
51+
52+
| Location | Asset | How |
53+
|----------|-------|-----|
54+
| README.md header | `logo/logo-256.png` | Centered image at top of README |
55+
| GitHub social preview | `social/social-preview-1280x640.png` | Settings → General → Social preview |
56+
57+
### Generated Domain Repos ({domain}-scan-demo-app)
58+
59+
| Location | Asset | How |
60+
|----------|-------|-----|
61+
| README.md header | `logo/logo-128.png` | Centered image, copy to `assets/branding/` |
62+
| GitHub social preview | `social/social-preview-1280x640.png` | Upload in repo settings |
63+
64+
### Generated Workshop Repos ({domain}-scan-workshop)
65+
66+
| Location | Asset | How |
67+
|----------|-------|-----|
68+
| README.md header | `logo/logo-128.png` | Centered image in README |
69+
| Workshop index.md | `logo/logo-128.png` | Header of GitHub Pages landing |
70+
| Browser favicon | `favicon/favicon.ico` | Via `_includes/head-custom.html` |
71+
| Apple touch icon | `favicon/apple-touch-icon.png` | Via `_includes/head-custom.html` |
72+
| GitHub social preview | `social/social-preview-1280x640.png` | Upload in repo settings |
73+
| Delivery guides | `logo/logo-128.png` | Header of half-day.md and full-day.md |
74+
75+
### GitHub Organization
76+
77+
| Location | Asset | How |
78+
|----------|-------|-----|
79+
| Org avatar | `logo/logo-512.png` | Organization Settings → Profile picture |
80+
81+
### Presentations and Documents
82+
83+
| Location | Asset | How |
84+
|----------|-------|-----|
85+
| PowerPoint title slide | `logo/logo-512.png` | With transparent background |
86+
| Word document header | `logo/logo-128.png` | Top-left header position |
87+
88+
## Social Preview Setup
89+
90+
To set the social preview on a GitHub repository:
91+
92+
```powershell
93+
# Via GitHub CLI (requires repo admin access)
94+
# Note: gh CLI doesn't support social preview directly — upload via web UI
95+
# Settings → General → Social preview → Edit → Upload image
96+
```
97+
98+
The social preview image appears when the repo URL is shared on social media, Slack, Teams, etc. It should be set on:
99+
100+
- `agentic-accelerator-framework`
101+
- `{domain}-scan-demo-app` (each domain)
102+
- `{domain}-scan-workshop` (each domain)
103+
- `agentic-accelerator-workshop` (main workshop)
104+
105+
## Favicon Setup for Workshops
106+
107+
Add these lines to the workshop `_includes/head-custom.html`:
108+
109+
```html
110+
<link rel="icon" type="image/x-icon" href="{{ site.baseurl }}/assets/branding/favicon.ico">
111+
<link rel="icon" type="image/png" sizes="32x32" href="{{ site.baseurl }}/assets/branding/favicon-32x32.png">
112+
<link rel="apple-touch-icon" sizes="180x180" href="{{ site.baseurl }}/assets/branding/apple-touch-icon.png">
113+
```
114+
115+
## README Header Template
116+
117+
Use this pattern for all repository READMEs:
118+
119+
```markdown
120+
<p align="center">
121+
<img src="assets/branding/logo-128.png" alt="Agentic Accelerator Framework" width="100">
122+
</p>
123+
124+
<h1 align="center">{Repository Display Name}</h1>
125+
126+
<p align="center">
127+
<em>{One-line description}</em>
128+
</p>
129+
```
17 KB
Loading
589 Bytes
Loading
17 KB
Loading
18.5 KB
Loading
1.4 KB
Loading
2.69 KB
Loading
79.1 KB
Loading
611 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)