Skip to content

Add sync framework for inheriting content into AGENTS.md#1581

Merged
nathanjmcdougall merged 3 commits intomainfrom
copilot/create-framework-for-content-inheritance
Mar 27, 2026
Merged

Add sync framework for inheriting content into AGENTS.md#1581
nathanjmcdougall merged 3 commits intomainfrom
copilot/create-framework-for-content-inheritance

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 27, 2026 •
edited
Loading

Adds a markdown comment convention for keeping content blocks in sync with source files, and uses it to embed docs/module-tree.txt into AGENTS.md.

Sync marker syntax

<!-- sync:docs/module-tree.txt -->

```text
<content from docs/module-tree.txt>

### Changes

- **`hooks/check-doc-sync.py`**: New bespoke prek hook that parses sync marker pairs, reads the referenced source file, and compares content (stripping leading/trailing whitespace and optional codeblock fences)
- **`AGENTS.md`**: Added `## Module Structure` section synced with `docs/module-tree.txt`
- **`.pre-commit-config.yaml`**: Registered `check-doc-sync` hook (priority 0, always_run, args: `["AGENTS.md"]`)

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs.

Copilot AI and others added 2 commits March 27, 2026 04:52
@nathanjmcdougall
Add check-doc-sync prek hook and sync AGENTS.md with docs/module-tree…
15912f3 
….txt

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/fe83eae1-2e6d-4e23-926b-9f9fdb6fdf37

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
@nathanjmcdougall
Move sync markers outside codeblock and strip codeblock fences in com…
02d098f 
…parison

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/fe83eae1-2e6d-4e23-926b-9f9fdb6fdf37

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Create a framework for inheriting content into AGENTS.md Add sync framework for inheriting content into AGENTS.md Mar 27, 2026
Copilot AI requested a review from nathanjmcdougall March 27, 2026 04:58
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review March 27, 2026 08:53
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 27, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Mar 27, 2026

Merging this PR will not alter performance

✅ 2 untouched benchmarks

Comparing copilot/create-framework-for-content-inheritance (02d098f) with main (77332b1)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (5ec237a) during the generation of this report, so 77332b1 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

@nathanjmcdougall nathanjmcdougall mentioned this pull request Mar 27, 2026
Closed
@nathanjmcdougall nathanjmcdougall merged commit 905dd17 into main Mar 27, 2026
20 checks passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/create-framework-for-content-inheritance branch March 27, 2026 09:03
@nathanjmcdougall nathanjmcdougall mentioned this pull request Mar 27, 2026
Closed
This was linked to issues Mar 27, 2026
Give clearer guidance on module structure in AGENTS.md #1574
Closed
Create a framework for inheriting content into AGENTS.md #1575
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@nathanjmcdougall nathanjmcdougall nathanjmcdougall approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@nathanjmcdougall nathanjmcdougall

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create a framework for inheriting content into AGENTS.md Give clearer guidance on module structure in AGENTS.md

2 participants

@nathanjmcdougall