Rename embedded AGENT.md database doc to AGENTS.md#11275
Open
kevglynn wants to merge 1 commit into
Open
Conversation
AGENTS.md is the emerging convention for agent-facing documentation. Rename the embedded database doc that `dolt init` auto-creates in every new database's `dolt_docs` table. Back-compat: the auto-add logic in docs_table.go now treats a legacy AGENT.md row as "found" so existing databases don't get a duplicate AGENTS.md auto-inserted beside their existing AGENT.md row. Closes dolthub#11138 Co-authored-by: Cursor <cursoragent@cursor.com>
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.
Summary
dolt_docsentry fromAGENT.mdtoAGENTS.mdto follow the emerging agents-file conventionAGENT.mdrow are handled: the auto-add logic treats the old name as "found" so no duplicateAGENTS.mdrow gets inserted beside itChanges
go/libraries/doltcore/doltdb/AGENT.md→AGENTS.md— renamed embedded file, updated title linego/libraries/doltcore/doltdb/system_table.go— updated//go:embeddirective andAgentDocconstant to"AGENTS.md"go/libraries/doltcore/sqle/dtables/docs_table.go— back-compat: auto-add check now accepts eitherAGENTS.mdor legacyAGENT.mdas "found"integration-tests/bats/init.bats— updated 2 test casesintegration-tests/bats/docs.bats— updated 9 test casesintegration-tests/mysql-client-tests/node/workbenchTests/docs.js— updated hardcoded doc nameThe
enginetest/dolt_queries.gotest usesdoltdb.AgentDocconstant so it updates automatically.Test plan
go veton all changed packages — cleaninitanddocssuitesNote on back-compat: The auto-add logic in
docs_table.gochecks for either name so that existing databases with a legacyAGENT.mdrow don't get a duplicateAGENTS.mdauto-inserted. Legacy rows are not migrated — this seemed like the least-surprise approach. Happy to adjust if you'd prefer migration or a different strategy.Closes #11138
Made with Cursor