Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

Commit 67d96ba

Browse files
committed
docs(readme): separate workflow and user documentation concerns
CHANGES - Create workflows/README.md for technical automation details - Remove workflow specifics from main README - Add cross-references between documentation IMPACT - Clear separation between user-facing and technical documentation - Improved maintainability with focused content per README
1 parent 9334bed commit 67d96ba

2 files changed

Lines changed: 38 additions & 14 deletions

File tree

.github/workflows/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Workflow Architecture
2+
3+
> Updated on 2025-07-15 by @KemingHe
4+
5+
Modular automation for weekly Python dependency manager documentation updates.
6+
7+
## 🏗️ Current System
8+
9+
```mermaid
10+
graph TD
11+
CRON_TRIGGER["⏰ Tuesday 6pm ET<br/>Cron Trigger"]
12+
ORCHESTRATOR["🎯 Orchestrator<br/>auto-update.yml"]
13+
UPDATE_DOCS["📚 Documentation Sync<br/>auto-update-docs.yml"]
14+
15+
CRON_TRIGGER --> ORCHESTRATOR
16+
ORCHESTRATOR --> UPDATE_DOCS
17+
```
18+
19+
**Security:** Pinned action hashes, signed commits, sequential execution
20+
21+
## 🚀 Planned Extensions
22+
23+
- **Workflows:** `auto-update-index.yml` (Tantivy), `auto-build-and-deploy.yml` (Docker)
24+
- **Managers:** pipenv, pdm, pixi
25+
- **Features:** Conditional updates, performance monitoring
26+
27+
## 🔧 Operations
28+
29+
- **Testing:** `workflow_dispatch` on both workflows
30+
- **Monitoring:** Check Tuesday runs for upstream changes

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Local MCP server providing unified search across Python dependency manager docum
66

77
## 📋 Overview
88

9-
Unified search for pip, poetry, uv, and conda docs via Docker with weekly auto-updates. Built with FastMCP and Tantivy.
9+
Unified search for pip, poetry, uv, and conda docs via Docker with automated weekly updates. Built with FastMCP and Tantivy for simple, AI-less full-text search.
1010

1111
## 🚀 Getting Started
1212

@@ -41,33 +41,27 @@ Query latest and unified documentation across all supported Python dependency ma
4141

4242
```plaintext
4343
python-dep-manager-companion-mcp-server/
44-
├── .github/workflows/
45-
│ ├── auto-update.yml # Orchestrator: Tuesday 6pm ET
46-
│ └── auto-update-docs.yml # Modular: Doc fetching workflow
44+
├── .github/workflows/ # Automation workflows (see workflows/README.md)
4745
├── docs/ # Project documentation
4846
├── src/
4947
│ ├── server.py # FastMCP server implementation
5048
│ ├── index.py # Tantivy search engine
51-
│ └── assets/ # Local documentation files
52-
│ ├── pip/ # Pip documentation .md files
53-
│ ├── poetry/ # Poetry documentation .md files
54-
│ ├── uv/ # UV documentation .md files
55-
│ └── conda/ # Conda documentation .md files
49+
│ └── assets/ # Auto-updated documentation files
5650
├── Dockerfile # Container build configuration
5751
└── pyproject.toml # Project dependencies and metadata
5852
```
5953

6054
## 🛠️ Development
6155

62-
**Transport Support**: Stdio (default) and HTTP modes following MCP standards.
56+
**Transport Support:** Stdio (default) and HTTP modes following MCP standards.
6357

64-
**Environment Variables**:
58+
**Environment Variables:**
6559

6660
- `TRANSPORT_MODE`: `stdio` or `http` (default: `stdio`)
6761
- `TRANSPORT_PORT`: HTTP server port (default: `8080`)
6862
- `TRANSPORT_HOST`: Host binding (default: `127.0.0.1`)
6963

70-
**Local Development**:
64+
**Local Development:**
7165

7266
```shell
7367
# Clone and setup
@@ -79,12 +73,12 @@ uv sync
7973
uv run python src/server.py stdio
8074
```
8175

82-
**Roadmap**: Adding support for pipenv, pdm, pixi, and additional Python package managers.
76+
**Roadmap:** Adding support for pipenv, pdm, pixi, and additional Python package managers.
8377

8478
## 📄 License
8579

8680
This project is licensed under the [MIT License](./LICENSE) - a permissive license that allows free use, modification, and distribution with attribution.
8781

8882
## 📞 Support
8983

90-
Open GitHub issues for bug reports and feature requests. Weekly documentation updates run automatically every Tuesday at 6pm ET with signed commits by `github-actions[bot]`.
84+
Open GitHub issues for bug reports and feature requests. Documentation is automatically updated weekly via workflows (see [.github/workflows/README.md](.github/workflows/README.md)).

0 commit comments

Comments
 (0)