docs: clarify that workspace .md files don't require gateway restart (#1728)#1740
Closed
darrenzeng2025 wants to merge 1 commit intosipeed:mainfrom
Closed
docs: clarify that workspace .md files don't require gateway restart (#1728)#1740darrenzeng2025 wants to merge 1 commit intosipeed:mainfrom
darrenzeng2025 wants to merge 1 commit intosipeed:mainfrom
Conversation
Add a note to the configuration documentation explaining that changes to AGENTS.md, SOUL.md, USER.md, IDENTITY.md, and MEMORY.md are automatically detected at runtime and do not require a gateway restart. Fixes sipeed#1728
10 tasks
sipeed-bot
bot
added
type: documentation
Collaborator
|
Fixed in: #1747 |
This was referenced Mar 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation to clarify that modifying workspace markdown files does not require a gateway restart.
Problem
Issue #1728 points out that the documentation doesn't mention whether the gateway needs to be restarted after modifying AGENTS.md and other .md files in the workspace.
Solution
Added a note in the Workspace Layout section of the configuration documentation explaining that changes to AGENTS.md, SOUL.md, USER.md, IDENTITY.md, and MEMORY.md are automatically detected at runtime via file modification time tracking. Users do not need to restart the gateway after modifying these files.
Type of Change
AI Code Generation
Related Issue
Fixes #1728
Technical Context
The code in
pkg/agent/context.goshows that these files are tracked insourcePaths()and the system uses file modification time (mtime) to automatically invalidate the system prompt cache when these files change.Checklist