بنقرة واحدة
sync-guides
Batch-generate web guide docs and i18n translations
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Batch-generate web guide docs and i18n translations
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Refactor pages, components, or queries for consistency
Prepare a new release with build, verify, changelog, and git tag
Review changed code against AWSops project conventions
Synchronize project documentation with current code state
| name | sync-guides |
| description | Batch-generate web guide docs and i18n translations |
| triggers | sync guides, guide update |
src 코드 변경에 따라 web 가이드 문서(한국어)와 i18n 영어/중국어(간체) 번역을 일괄 생성/업데이트합니다.
/sync-guides 명령어로 실행
인프라, AgentCore, 배포 스크립트 변경 시 — Canvas React 컴포넌트 포함 가이드.
| 트리거 파일 | 라우트 | 가이드 | Canvas 컴포넌트 |
|---|---|---|---|
infra-cdk/lib/*.ts | __infra__ | overview/dashboard | ArchitectureFlow |
agent/agent.py | __agentcore__ | overview/agentcore | AgentCoreFlow |
scripts/0*.sh | __deployment__ | getting-started/deployment | DeploymentPipeline |
Canvas 컴포넌트 위치: web/src/components/diagrams/
src/app 페이지 변경 시 — 표준 서비스 가이드 (Screenshot + 기능 설명).
| 트리거 파일 | 라우트 | 가이드 카테고리 |
|---|---|---|
src/app/*/page.tsx | 자동 추출 | Compute, Network, Storage, Monitoring, Security |
src/lib/queries/*.ts | 쿼리명 기반 | 해당 서비스 |
시작 가이드 변경 시 — 로그인, 네비게이션, AI 어시스턴트, 인증 흐름.
.omc/state/pending-guides.json에서 축적된 변경 목록을 읽습니다.
Hook(accumulate-pending-guides.sh)이 파일 변경 시 자동으로 축적합니다.
감지 대상:
src/app/*/page.tsx, src/lib/queries/*.ts, src/components/*.tsx (Tier 2)infra-cdk/lib/*.ts, agent/agent.py, scripts/0*.sh (Tier 1)각 pending 항목에 대해:
web/docs/{category}/{service}.md 존재 여부web/docs/storage/ebs.md)를 템플릿으로 참조web/i18n/en/docusaurus-plugin-content-docs/current/{category}/{service}.mdweb/i18n/zh-Hans/docusaurus-plugin-content-docs/current/{category}/{service}.mdTier 1 가이드에 사용되는 인터랙티브 Canvas 시각화:
공통 훅: web/src/components/diagrams/useCanvas.ts
useCanvas(draw, height): Canvas ref + ResizeObserver + HiDPI + animation loop + mouse trackingTHEME: AWSops 테마 색상 (bg, cyan, green, purple, orange, text, muted)roundRect(), isHover(): 유틸리티 함수typeof window === 'undefined')컴포넌트 구조:
import React from 'react';
import { useCanvas, THEME, roundRect, isHover, canvasWrapperStyle } from './useCanvas';
export default function DiagramName() {
const { canvasRef, mouseRef } = useCanvas((ctx, canvas, frame, mouse) => {
// Clear + draw nodes + connections + particles + hover effects
}, 500);
return (
<div style={canvasWrapperStyle}>
<canvas ref={canvasRef} style={{ width: '100%', height: 500, display: 'block' }} />
</div>
);
}
기존 컴포넌트:
| 컴포넌트 | 파일 | 시각화 내용 |
|---|---|---|
ArchitectureFlow | ArchitectureFlow.tsx | CloudFront → ALB → EC2 → Steampipe/AgentCore |
AgentCoreFlow | AgentCoreFlow.tsx | AI Router → 10 Routes → AgentCore Runtime |
DeploymentPipeline | DeploymentPipeline.tsx | 10단계 배포 파이프라인 타임라인 |
AuthFlow | AuthFlow.tsx | Cognito 인증 시퀀스 다이어그램 |
---
sidebar_position: N
---
import Screenshot from '@site/src/components/Screenshot';
# {서비스명}
{서비스 한 줄 설명}
<Screenshot src="/screenshots/{category}/{service}.png" alt="{서비스명}" />
## 주요 기능
### 통계 카드
- StatsCard 컴포넌트에서 추출한 카드 목록
### 시각화 차트
- Recharts 컴포넌트에서 추출한 차트 목록
### 데이터 테이블/탭
- 테이블 구조 설명
## 사용 방법
- 주요 워크플로우 3-5개
## 사용 팁
- :::tip, :::info 형식의 팁 2-3개
## AI 분석 팁
- AI 어시스턴트 질문 예시 4-5개
## 관련 페이지
- 관련 페이지 링크 3-5개
StatsCard 컴포넌트: 카드 label, value, color → 통계 카드 섹션PieChart, BarChart, LineChart: 차트 종류 → 시각화 차트 섹션Tab, TabPanel: 탭 구조 → 데이터 테이블 섹션fetch('/awsops/api/...'): API 호출 패턴 → 데이터 소스 설명src/lib/queries/*.ts): 주요 컬럼 → 데이터 필드 설명| src/app 경로 | sidebars.ts 카테고리 | web/docs 경로 |
|---|---|---|
| ec2, lambda, ecs, ecr, k8s* | Compute | compute/ |
| vpc, cloudfront-cdn, waf, topology | Network & CDN | network/ |
| ebs, s3, rds, dynamodb, elasticache, opensearch, msk | Storage & DB | storage/ |
| monitoring, bedrock, cloudwatch, cloudtrail, cost, inventory | Monitoring | monitoring/ |
| iam, security, compliance | Security | security/ |
.omc/state/pending-guides.json의 처리된 항목 제거--clear 플래그: pending 목록 전체 초기화/ask gemini)/sync-guides # pending 목록 기반 일괄 생성
/sync-guides --all # 모든 src/app 페이지 대상 전체 동기화
/sync-guides --clear # pending 목록 초기화
/sync-guides --dry # 생성할 가이드 목록만 미리보기