|
| 1 | +<p align="center"> |
| 2 | + <img src="./assets/banner.svg" alt="Figures Diagram banner" width="100%"> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <img src="https://img.shields.io/github/v/release/z595484296-dev/Figures-Diagram?display_name=tag&sort=semver" alt="Release"> |
| 7 | + <img src="https://img.shields.io/github/license/z595484296-dev/Figures-Diagram" alt="License"> |
| 8 | + <img src="https://img.shields.io/badge/Codex-Skill-0F766E" alt="Codex Skill"> |
| 9 | + <img src="https://img.shields.io/badge/Focus-Academic%20Diagrams-2563EB" alt="Academic Diagrams"> |
| 10 | + <img src="https://img.shields.io/badge/Render-OpenRouter-082F49" alt="OpenRouter"> |
| 11 | +</p> |
| 12 | + |
1 | 13 | # Figures Diagram |
2 | 14 |
|
3 | 15 | Codex skill for academic non-numeric diagram generation and OpenRouter-backed rendering. |
4 | 16 |
|
5 | 17 | This repository packages a reusable workflow for turning diagram ideas into polished English prompts for image models and, when requested, directly rendering publication-oriented draft figures. |
6 | 18 |
|
7 | | -## Highlights |
| 19 | +## At a Glance |
8 | 20 |
|
9 | 21 | - Prompt engineering for flowcharts, frameworks, concept maps, taxonomies, and timelines |
10 | 22 | - Academic defaults for layout, readability, color usage, and labeling |
11 | 23 | - Prompt-only mode for reusable figure ideation |
12 | 24 | - Production mode for direct OpenRouter image rendering |
13 | 25 | - Environment-variable based credential handling instead of hardcoded secrets |
14 | 26 |
|
| 27 | +## Preview |
| 28 | + |
| 29 | +<p align="center"> |
| 30 | + <img src="./assets/preview.svg" alt="Figures Diagram preview" width="100%"> |
| 31 | +</p> |
| 32 | + |
| 33 | +## Architecture |
| 34 | + |
| 35 | +```mermaid |
| 36 | +flowchart LR |
| 37 | + A["User Diagram Request"] --> B["Figure Type Classifier"] |
| 38 | + B --> C["Input Inference and Defaults"] |
| 39 | + C --> D["Prompt Construction Engine"] |
| 40 | + D --> E["Prompt-Only Output"] |
| 41 | + D --> F["OpenRouter Production Renderer"] |
| 42 | + F --> G["Image File / Prompt File / JSON Response"] |
| 43 | +``` |
| 44 | + |
15 | 45 | ## Best Fit |
16 | 46 |
|
17 | 47 | Use this skill for: |
@@ -48,6 +78,9 @@ references/ |
48 | 78 | style-and-tools.md |
49 | 79 | scripts/ |
50 | 80 | render_via_openrouter.py |
| 81 | +assets/ |
| 82 | + banner.svg |
| 83 | + preview.svg |
51 | 84 | ``` |
52 | 85 |
|
53 | 86 | ## Quick Start |
@@ -103,7 +136,7 @@ The rendering script also supports Windows user environment variables. |
103 | 136 |
|
104 | 137 | ## Companion Repository |
105 | 138 |
|
106 | | -- `Thesis-Pipeline` for proposal drafting, literature retrieval, and methodology planning |
| 139 | +- [`Thesis-Pipeline`](https://github.com/z595484296-dev/Thesis-Pipeline) for proposal drafting, literature retrieval, and methodology planning |
107 | 140 |
|
108 | 141 | ## Design Principles |
109 | 142 |
|
|
0 commit comments