Skip to content

Commit bc64950

Browse files
committed
docs: generalize agent guidance
1 parent 61e4b42 commit bc64950

7 files changed

Lines changed: 29 additions & 14 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,7 @@ env.bak/
111111
venv.bak/
112112

113113
# Private maintainer configuration
114-
removed-provider.md
115-
docs/removed-provider-removed-provider.md
114+
.agents/
116115
tmp_pytest/
117116

118117
# Spyder project settings

‎AGENTS.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
# Shared agent instructions
22

3-
`removed-provider.md` is the authoritative project memory for every agent working in
4-
this repository. Read it completely before inspecting, changing, or running
5-
the project, and follow it for the entire task.
3+
This file is the public source of guidance for any coding agent working in
4+
this repository. Read it before inspecting, changing, or running the project.
65

7-
Repository workflows and policies under `.removed-provider/` are shared agent settings,
8-
not removed-provider-only guidance. Read the relevant files before performing the
9-
corresponding operation. If an agent does not support the removed-provider slash-command
10-
syntax, follow the command prompt manually:
6+
Private local maintainer guidance and optional workflows may live under
7+
`.agents/`. Read the relevant files when they are available:
118

12-
- `.removed-provider/commands/release/prepare.toml` defines release preparation.
13-
- `.removed-provider/commands/release/verify.toml` defines release verification.
14-
- `.removed-provider/policies/git-override.toml` records repository Git tool policy.
9+
- `.agents/commands/release/prepare.toml` defines release preparation.
10+
- `.agents/commands/release/verify.toml` defines release verification.
11+
- `.agents/policies/git-override.toml` records repository Git tool policy.
1512

1613
Tool policies never override the user's request, the host's permissions, or
1714
higher-priority safety instructions.

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
- Seven new MCP tools for read operations and safe publishing: `get_status`, `list_publications`, `list_drafts`, `get_draft`, `schedule_draft`, `unschedule_draft`, and `publish_draft_checked`.
7272
- Pre-publish validation, interactive confirmation requirements, and no-email defaults for the new `publish_draft_checked` MCP tool.
7373
- Verified MCP client configuration examples in `docs/mcp.md`.
74-
- Documentation for removed-provider CLI with removed-provider (`docs/removed-provider-removed-provider.md`).
74+
- Documentation for local agent workflows.
7575

7676
### Improved
7777

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ See [MCP server](docs/mcp.md) for the tool list and safety notes.
251251
- [Low-level Python API](docs/low-level-api.md)
252252
- [YAML drafts](docs/yaml.md)
253253
- [MCP server](docs/mcp.md)
254+
- [Agent workflow](docs/agents.md)
254255
- [Safety and publishing behavior](docs/safety.md)
255256
- [Troubleshooting](docs/troubleshooting.md)
256257
- [Compatibility policy](docs/compatibility.md)

‎docs/agents.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: default
3+
title: Agent workflow
4+
---
5+
6+
# Agent workflow
7+
8+
This repository can be maintained with any compatible coding agent. Read
9+
[`AGENTS.md`](../AGENTS.md) before inspecting or changing the project.
10+
11+
Private maintainer configuration is optional and lives under `.agents/`; it is
12+
not distributed with the package. Do not commit credentials, cookies, tokens,
13+
or local service-account files.
14+
15+
Use the documented Poetry commands for dependency installation, offline tests,
16+
and release validation. Live tests require explicit maintainer authorization
17+
and must never publish content.

‎docs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ publish, or delete it.
2020
- [Python SDK](python-sdk.md)
2121
- [Markdown syntax](markdown.md)
2222
- [MCP setup](mcp.md)
23+
- [Agent workflow](agents.md)
2324
- [Safety and publishing behavior](safety.md)
2425
- [Troubleshooting](troubleshooting.md)
2526

‎docs/releases/0.4.0.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This release makes the optional MCP server significantly more useful for inspect
1313
- Seven new MCP tools for read operations and safe publishing: `get_status`, `list_publications`, `list_drafts`, `get_draft`, `schedule_draft`, `unschedule_draft`, and `publish_draft_checked`.
1414
- Pre-publish validation, interactive confirmation requirements, and no-email defaults for the new `publish_draft_checked` MCP tool.
1515
- Verified MCP client configuration examples in `docs/mcp.md`.
16-
- Documentation for removed-provider CLI with removed-provider (`docs/removed-provider-removed-provider.md`).
16+
- Documentation for local agent workflows.
1717

1818
### Improved
1919

0 commit comments

Comments
 (0)