yukikase commited on
Commit
df16d3c
·
1 Parent(s): 9b201b1

fix: リポジトリ名参照をcircle-search-26-apiに統一

Browse files

フォーク元のchibafes-website-api-v2への参照をすべて修正

変更したファイル:
- .github/workflows/deploy_to_hf_space.yaml (2箇所)
- README.md (2箇所)
- docs/【有効】2026-01-19_サークル検索API実装ガイド.md (6箇所)
- docs/システムガイド.md (3箇所)
- docs/基礎知識.md (1箇所)

.github/workflows/deploy_to_hf_space.yaml CHANGED
@@ -19,7 +19,7 @@ jobs:
19
  HF_TOKEN: ${{ secrets.HF_TOKEN }}
20
  run: |
21
  # Hugging Face Spaceのリポジトリをクローン
22
- git clone https://chibafes-dev-admin:$HF_TOKEN@huggingface.co/spaces/chibafes-dev/chibafes-website-api-v2 space-repo
23
 
24
  # .gitディレクトリとクローン先ディレクトリを除き、全ファイルをコピー
25
  # これにより、Actions内で生成したデータファイルもSpaceに同期
@@ -35,4 +35,4 @@ jobs:
35
  git commit -m "Update from GitHub Actions"
36
  fi
37
  # chibafes-dev-admin の部分はトークンを発行した Hugging Face のユーザー名
38
- git push https://chibafes-dev-admin:$HF_TOKEN@huggingface.co/spaces/chibafes-dev/chibafes-website-api-v2 main
 
19
  HF_TOKEN: ${{ secrets.HF_TOKEN }}
20
  run: |
21
  # Hugging Face Spaceのリポジトリをクローン
22
+ git clone https://chibafes-dev-admin:$HF_TOKEN@huggingface.co/spaces/chibafes-dev/circle-search-26-api space-repo
23
 
24
  # .gitディレクトリとクローン先ディレクトリを除き、全ファイルをコピー
25
  # これにより、Actions内で生成したデータファイルもSpaceに同期
 
35
  git commit -m "Update from GitHub Actions"
36
  fi
37
  # chibafes-dev-admin の部分はトークンを発行した Hugging Face のユーザー名
38
+ git push https://chibafes-dev-admin:$HF_TOKEN@huggingface.co/spaces/chibafes-dev/circle-search-26-api main
README.md CHANGED
@@ -26,7 +26,7 @@ pinned: false
26
  ## ローカル作業の準備
27
  ### 1. リポジトリをクローン
28
  ```bash
29
- git clone https://github.com/chibafes-dev/chibafes-website-api-v2.git
30
  ```
31
  > クローンのためには `Read` 以上のリポジトリ権限が必要です。また、作業をしてプッシュをするには `Write` 以上のリポジトリ権限が必要です。
32
 
@@ -153,7 +153,7 @@ HF_EMBEDDINGS_REPO_ID=...
153
  <details>
154
  <summary>手動で切り替えたい場合</summary>
155
 
156
- このリポジトリ `chibafes-website-api-v2` があるフォルダに移動し、以下のコマンドを実行
157
  ```bash
158
  pyenv local 3.12.11
159
  ```
 
26
  ## ローカル作業の準備
27
  ### 1. リポジトリをクローン
28
  ```bash
29
+ git clone https://github.com/chibafes-dev/circle-search-26-api.git
30
  ```
31
  > クローンのためには `Read` 以上のリポジトリ権限が必要です。また、作業をしてプッシュをするには `Write` 以上のリポジトリ権限が必要です。
32
 
 
153
  <details>
154
  <summary>手動で切り替えたい場合</summary>
155
 
156
+ このリポジトリ `circle-search-26-api` があるフォルダに移動し、以下のコマンドを実行
157
  ```bash
158
  pyenv local 3.12.11
159
  ```
docs/【有効】2026-01-19_サークル検索API実装ガイド.md CHANGED
@@ -18,7 +18,7 @@
18
  ## 全体フロー概要
19
 
20
  ```
21
- 1. chibafes-website-api-v2 をフォーク
22
  2. サークル検索用にコード改造
23
  3. ローカルでテスト
24
  4. Huggingface Space にデプロイ
@@ -30,9 +30,9 @@
30
 
31
  ## Phase 1: リポジトリのフォークとセットアップ
32
 
33
- ### Step 1-1: chibafes-website-api-v2 をフォーク
34
 
35
- 1. ブラウザで https://github.com/chibafes-dev/chibafes-website-api-v2 を開く
36
 
37
  2. 右上の "Fork" ボタンをクリック
38
 
@@ -52,7 +52,7 @@ git clone https://github.com/YOUR_USERNAME/circle-search-api.git
52
  cd circle-search-api
53
 
54
  # リモートに upstream を追加(オリジナルの追跡用)
55
- git remote add upstream https://github.com/chibafes-dev/chibafes-website-api-v2.git
56
  ```
57
 
58
  ### Step 1-3: Python環境のセットアップ
@@ -1334,7 +1334,7 @@ Cloudflare Pagesが自動的にデプロイします。
1334
 
1335
  このガイドに従うことで、以下が実現できます:
1336
 
1337
- chibafes-website-api-v2 をフォークしてサークル検索用に改造
1338
  ✅ BM25F + fastText による高精度な日本語検索
1339
  ✅ Huggingface Space での無料ホスティング
1340
  ✅ GitHub Actions による自動デプロイ
@@ -1349,7 +1349,7 @@ Cloudflare Pagesが自動的にデプロイします。
1349
 
1350
  ## 参考資料
1351
 
1352
- - [chibafes-website-api-v2 Documentation](./docs/)
1353
  - [Huggingface Spaces Documentation](https://huggingface.co/docs/hub/spaces)
1354
  - [FastAPI Documentation](https://fastapi.tiangolo.com/)
1355
  - [GitHub Actions Documentation](https://docs.github.com/actions)
 
18
  ## 全体フロー概要
19
 
20
  ```
21
+ 1. circle-search-26-api をフォーク
22
  2. サークル検索用にコード改造
23
  3. ローカルでテスト
24
  4. Huggingface Space にデプロイ
 
30
 
31
  ## Phase 1: リポジトリのフォークとセットアップ
32
 
33
+ ### Step 1-1: circle-search-26-api をフォーク
34
 
35
+ 1. ブラウザで https://github.com/chibafes-dev/circle-search-26-api を開く
36
 
37
  2. 右上の "Fork" ボタンをクリック
38
 
 
52
  cd circle-search-api
53
 
54
  # リモートに upstream を追加(オリジナルの追跡用)
55
+ git remote add upstream https://github.com/chibafes-dev/circle-search-26-api.git
56
  ```
57
 
58
  ### Step 1-3: Python環境のセットアップ
 
1334
 
1335
  このガイドに従うことで、以下が実現できます:
1336
 
1337
+ circle-search-26-api をフォークしてサークル検索用に改造
1338
  ✅ BM25F + fastText による高精度な日本語検索
1339
  ✅ Huggingface Space での無料ホスティング
1340
  ✅ GitHub Actions による自動デプロイ
 
1349
 
1350
  ## 参考資料
1351
 
1352
+ - [circle-search-26-api Documentation](./docs/)
1353
  - [Huggingface Spaces Documentation](https://huggingface.co/docs/hub/spaces)
1354
  - [FastAPI Documentation](https://fastapi.tiangolo.com/)
1355
  - [GitHub Actions Documentation](https://docs.github.com/actions)
docs/システムガイド.md CHANGED
@@ -96,7 +96,7 @@
96
  ## 3. ディレクトリ構成と役割
97
 
98
  ```
99
- chibafes-website-api-v2/
100
  ├── app/ # メインアプリケーション
101
  │ ├── main.py # FastAPI エントリポイント
102
  │ ├── search/
@@ -859,8 +859,8 @@ curl -X POST -H "X-API-KEY: key" \
859
  **手順:**
860
  ```bash
861
  # 1. リポジトリをクローン
862
- git clone https://github.com/chibafes-dev/chibafes-website-api-v2.git
863
- cd chibafes-website-api-v2
864
 
865
  # 2. Pythonの仮想環境を作成
866
  python3.11 -m venv venv
 
96
  ## 3. ディレクトリ構成と役割
97
 
98
  ```
99
+ circle-search-26-api/
100
  ├── app/ # メインアプリケーション
101
  │ ├── main.py # FastAPI エントリポイント
102
  │ ├── search/
 
859
  **手順:**
860
  ```bash
861
  # 1. リポジトリをクローン
862
+ git clone https://github.com/chibafes-dev/circle-search-26-api.git
863
+ cd circle-search-26-api
864
 
865
  # 2. Pythonの仮想環境を作成
866
  python3.11 -m venv venv
docs/基礎知識.md CHANGED
@@ -520,7 +520,7 @@ git push origin feature/my-feature
520
  ### このプロジェクトのバージョン管理
521
 
522
  ```
523
- GitHub リポジトリ: chibafes-dev/chibafes-website-api-v2
524
  ブランチ: main(本番用), develop(開発用)
525
  ```
526
 
 
520
  ### このプロジェクトのバージョン管理
521
 
522
  ```
523
+ GitHub リポジトリ: chibafes-dev/circle-search-26-api
524
  ブランチ: main(本番用), develop(開発用)
525
  ```
526