Create Guides
User and Developer Guides are handy to provide help users and developers understand projects by highlighting the features, functions and approaches. In addition, README.md, DEVELOPER.md and AGENTS.md files are handy for overviews.
Table of Contents
Digital Tool Guides & Prompts
Prompts
Guides and Overviews
| Project / Repository | Architecture (DEVELOPER.md) | Developer & User Guides | AI Agent Rules (AGENTS.md) |
|---|---|---|---|
DocumentTools (this repo) | DEVELOPER.md | Developer Guide | AGENTS.md |
qtl2shiny | DEVELOPER.md | Developer Guide (Articles) | AGENTS.md |
geyser | DEVELOPER.md | R Developer Guide Python Developer Guide | AGENTS.md |
landmapyr | DEVELOPER.md | — | AGENTS.md |
rainDrought | DEVELOPER.md | User Guide | AGENTS.md |
byandell-sysgen | DEVELOPER.md | — | - |
DocumentTools Repository Developer Architecture
For full details on this repository’s static site generation pipeline, directory map, frontmatter metadata rules, automated link-checking workflows, and AI pair-programming instructions, see:
- Developer Architecture & Maintenance Guide (
DEVELOPER.md): Master reference for maintaining and compilingDocumentTools. - Check External Links Guide: Instructions and audit reports for running
scripts/check_links.py. - Create Developer Guides Blueprint: Universal template for authoring developer guides across R, Python, and Documentation projects.