Skip to content

Feat/agents md setup#2

Merged
blackandredbot merged 5 commits intomainfrom
feat/agents-md-setup
Mar 13, 2026
Merged

Feat/agents md setup#2
blackandredbot merged 5 commits intomainfrom
feat/agents-md-setup

Conversation

@blackandredbot
Copy link
Owner

What does this change?

How was it tested?

Checklist

  • uv run pytest passes
  • uv run ruff check passes
  • uv run ruff format --check passes

Michael Foley added 5 commits March 13, 2026 12:47
- Create AGENTS.md with all 12 sections following the AGENTS.md open format
- Add docs site pages (architecture, contributing, usage, installation, etc.)
- Add docs index link back to GitHub repo (mirrors upstream README change)
- Add star-their-repo callout for GVM/VideoMaMa in docs/usage.md
- Add test_agents_md.py with 18 unit tests and 5 Hypothesis PBT tests
- Add test_docs_structure.py for docs site structure validation
- docs/LLM_HANDOVER.md remains unmodified
- Move hypothesis imports to top of file (E402) in test_agents_md.py
- Rename ambiguous variable 'l' to 'ln' (E741) in test_docs_structure.py
- Apply ruff format to both test files
The cross-platform uv.lock drift was fixed in nikopueringer#133 (extras-based
backends). Remove the now-stale uv.lock caveat from Platform-Specific
Caveats, the prohibited-action entry, and the corresponding test
assertions.
Add docs/ai-assisted-development.md covering context sources (AGENTS.md,
LLM_HANDOVER.md), a tool-agnostic quick start, and per-tool configuration
sections for Kiro, Claude Code, Cursor, GitHub Copilot, Windsurf, and
Gemini CLI using pymdownx.tabbed content tabs.

Update zensical.toml nav (Developer Guide section) and docs/index.md
(Developer Guide card) with the new page entry.

Add structural and property-based tests to tests/test_docs_structure.py:
- test_ai_dev_page_exists, test_ai_dev_page_in_nav
- TestNavEntryPreservation (Property 1)
- TestIndexPageContentPreservation (Property 2)
- test_ai_dev_page_has_required_content
- test_index_page_links_to_ai_dev
@blackandredbot blackandredbot merged commit ea54c98 into main Mar 13, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant