Skip to content

Commit bcf998e

Browse files
Copilothah23255
Copilot
and
hah23255
committed
Add badges to README and GitHub profile pinning guides
Co-authored-by: hah23255 <203431925+hah23255@users.noreply.github.com>
1 parent 4253318 commit bcf998e

File tree

3 files changed

+137
-0
lines changed

3 files changed

+137
-0
lines changed

‎.github/PINNING_GUIDE.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Pinning This Repository to Your GitHub Profile
2+
3+
This guide explains how to pin the AEC RAG System repository to your GitHub profile overview page, where you have **1 available spot** for pinned repositories.
4+
5+
## Why Pin This Repository?
6+
7+
Pinned repositories appear prominently on your GitHub profile and showcase your best work. This repository demonstrates:
8+
9+
- ✅ Production-grade RAG system implementation
10+
- ✅ Modern Python development with FastAPI
11+
- ✅ Docker/containerization expertise
12+
- ✅ AI/ML integration (GraphRAG, LLM, embeddings)
13+
- ✅ Domain expertise in AEC industry
14+
- ✅ Clean code with comprehensive documentation
15+
16+
## How to Pin This Repository
17+
18+
### Step 1: Go to Your GitHub Profile
19+
Visit: https://github.com/hah23255
20+
21+
### Step 2: Customize Your Pins
22+
1. Look for the "Customize your pins" button on your profile
23+
2. Click it to open the pin customization dialog
24+
25+
### Step 3: Select This Repository
26+
1. In the dialog, you'll see a list of your repositories
27+
2. Find "aec-rag-system" in the list
28+
3. Check the box next to it
29+
4. GitHub allows up to 6 pinned repositories
30+
31+
### Step 4: Save Changes
32+
Click "Save pins" to update your profile
33+
34+
## Making This Repository More Attractive
35+
36+
To enhance the appearance when pinned, ensure:
37+
38+
### 1. Repository Description (via GitHub Settings)
39+
Set a compelling description in your repository settings:
40+
```
41+
Production-grade GraphRAG system for AEC design management. Features local LLMs, CAD parsing, version tracking, and impact analysis. Built with FastAPI, Ollama, and ChromaDB.
42+
```
43+
44+
### 2. Topics (see REPOSITORY_TOPICS.md)
45+
Add relevant topics to categorize your repository and improve discoverability.
46+
47+
### 3. Social Preview Image (Optional)
48+
1. Go to repository Settings
49+
2. Scroll to "Social preview"
50+
3. Upload an image (1280x640px recommended)
51+
- Could be a diagram of the system architecture
52+
- Or a screenshot of the API documentation
53+
- Or a custom banner with the project name and key features
54+
55+
### 4. Repository Website (Optional)
56+
If you deploy the API publicly, add the URL in repository settings under "Website"
57+
58+
## Profile Overview Best Practices
59+
60+
When someone views your pinned repositories, they see:
61+
- Repository name
62+
- Description (first ~100 characters)
63+
- Primary language badge (Python)
64+
- Stars/Forks count
65+
- Topics (first few)
66+
67+
Make sure your repository has:
68+
- ✅ Clear, concise description
69+
- ✅ Comprehensive README with badges (already added)
70+
- ✅ Relevant topics
71+
- ✅ MIT License (already configured)
72+
- ✅ Active development status
73+
74+
## Current Repository Status
75+
76+
✅ **README Enhanced** - Professional badges added
77+
✅ **Documentation** - Comprehensive README, INDEX.md, contributing guidelines
78+
✅ **License** - MIT License configured
79+
✅ **Project Metadata** - pyproject.toml properly configured
80+
✅ **Code Quality** - Black, Ruff, MyPy configured
81+
✅ **Docker Ready** - docker-compose.yml for easy deployment
82+
83+
This repository is ready to be pinned and will make a strong impression on your GitHub profile!

‎.github/REPOSITORY_TOPICS.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Repository Topics
2+
3+
To make this repository more discoverable and attractive when pinned to your GitHub profile, consider adding the following topics via GitHub's web interface:
4+
5+
## Suggested Topics
6+
7+
### Technology Stack
8+
- `graphrag`
9+
- `rag`
10+
- `llm`
11+
- `fastapi`
12+
- `python`
13+
- `docker`
14+
- `ollama`
15+
- `chromadb`
16+
17+
### Domain/Industry
18+
- `aec`
19+
- `architecture`
20+
- `engineering`
21+
- `construction`
22+
- `cad`
23+
- `design-management`
24+
25+
### AI/ML
26+
- `retrieval-augmented-generation`
27+
- `local-llm`
28+
- `embeddings`
29+
- `knowledge-graph`
30+
- `natural-language-processing`
31+
32+
### Features
33+
- `document-processing`
34+
- `version-tracking`
35+
- `impact-analysis`
36+
37+
## How to Add Topics
38+
39+
1. Go to your repository on GitHub: https://github.com/hah23255/aec-rag-system
40+
2. Click the ⚙️ (Settings) gear icon next to "About" on the right side
41+
3. Add topics from the list above (GitHub allows up to 20 topics)
42+
4. Click "Save changes"
43+
44+
Topics help with:
45+
- Repository discoverability in GitHub search
46+
- Making the repository more attractive when pinned to your profile
47+
- Showing relevant technology tags to potential contributors

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# AEC Design Management RAG System
22

3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
5+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
6+
[![FastAPI](https://img.shields.io/badge/FastAPI-0.100+-00a393.svg)](https://fastapi.tiangolo.com)
7+
[![Docker](https://img.shields.io/badge/Docker-Ready-2496ED.svg)](https://www.docker.com/)
8+
[![Status](https://img.shields.io/badge/Status-Development-orange.svg)]()
9+
310
A production-grade Retrieval-Augmented Generation (RAG) system for Architecture, Engineering, and Construction (AEC) design management, powered by GraphRAG and local LLMs.
411

512
## Features

0 commit comments

Comments
 (0)