arch-publish

Name: arch-publish
Availability: InStock
Author: Weiran

Publish microservice architecture docs to a centralized arch-docs repository.

3|Updated Apr 2, 2026

Search Tags:#automation #architecture #documentation #publish #docs #system-design

Ready to run

npx skills add https://github.com/weiran-tech/agent-skills --skill arch-publish

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: arch-publish
Source: https://github.com/weiran-tech/agent-skills/tree/main/skills/arch-publish
Command: npx skills add https://github.com/weiran-tech/agent-skills --skill arch-publish

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

将当前微服务的架构文档推送到 arch-docs 汇总目录并按服务名称分层存储，帮助团队实现一致、可追溯的体系设计记录。

Core Features & Use Cases

自动发现并将 docs/ 目录下的所有 .md 文档推送到 arch-docs 的对应服务目录。
路径和服务名自动解析：优先读取 .arch-docs.yml、application.yml/bootstrap.yml、pom.xml 来确定 arch-docs 路径与 service 名称。
覆盖式更新：直接覆盖 arch-docs 中的文档，确保以当前服务仓库的文档为准。
自动更新索引：在 arch-docs/README.md 中新增或更新对应服务的条目，保持全局目录的一致性。

Quick Start

Run arch-publish in your project root to publish the current service's architecture documentation to arch-docs.

Frequently Asked Questions about arch-publish

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I publish microservice architecture documentation to a centralized repository?▼

Publish architecture docs by running arch-publish in your project root to copy Markdown files into arch-docs. It locates the centralized repository using a .arch-docs.yml config and automatically organizes documents by service name.

How does the service name get resolved when publishing architecture docs?▼

Service name resolution for publishing docs prioritizes the .arch-docs.yml configuration, then falls back to reading application.yml, bootstrap.yml, or pom.xml. This automated derivation ensures documents route to the correct service directory without manual input.

Do I need a specific config file to automate architecture documentation publishing?▼

Yes, you need a .arch-docs.yml file to specify the arch-docs path. The microservice repository must also contain a docs/ directory with Markdown files to enable the automated publishing and index updating process.

What happens to existing architecture docs when I republish updated Markdown files?▼

Republishing architecture docs performs an overwrite update, directly replacing existing documents in the target arch-docs path. This ensures the current service repository's documentation always serves as the single source of truth.

How is the global index maintained when new service architecture docs are added?▼

The global index is maintained by automatically updating the arch-docs/README.md file. Publishing docs adds or updates the corresponding service entry in the index README, keeping the centralized architecture directory consistent.

Can I use arch-publish for Java microservices using Spring Boot and Maven?▼

Yes, it works with Java and Spring Boot microservices. The tool derives the service name from application.yml, bootstrap.yml, or pom.xml, making it compatible with standard Maven and Spring Boot project structures.