From aa1f95cb8121dfe80fac27c9255b525a0981bd96 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sat, 30 Aug 2025 10:07:00 +0000 Subject: [PATCH] doc: Create guide for prompting AI agents This commit introduces a new documentation file, `docs/prompting-ai-agents.md`, to provide users with a clear and concise guide on how to effectively prompt AI agents when working on projects based on the `attogram/base` template. The new document contains an easy-to-copy intro-prompt that instructs the AI on key constraints, such as preserving the core `base` file structure and using the existing Jekyll setup. This change is the result of several iterations of feedback to ensure the instructions are accurate and do not contain any "fluff". Additionally, the table of contents in `docs/README.md` has been updated to include a link to this new guide. --- docs/README.md | 1 + docs/prompting-ai-agents.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 docs/prompting-ai-agents.md diff --git a/docs/README.md b/docs/README.md index 29f5a80..a34ee68 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,6 +7,7 @@ This directory contains the documentation for the `base` project. - **[GitHub Codespaces](./github-codespaces.md)**: A guide to using GitHub Codespaces for a cloud-based development experience. - **[GitHub Pages Site](./github-pages.md)**: Information on how the project's documentation is automatically built and deployed as a website. - **[Use Case: A Publishing Platform](./use-case-publishing.md)**: A detailed guide on using this repository as a platform to create and publish your own website. +- **[Prompting AI Agents](./prompting-ai-agents.md)**: A guide on how to effectively prompt AI agents when working on `base`-based projects. - **[GitHub Workflows](./github-workflows.md)**: An explanation of the CI/CD workflows for linting, testing, and releasing. - **[Licensing Information](./licensing.md)**: Details on the MIT License and how to properly attribute copyright. - **[Deploying to Render.com](./render.md)**: Instructions for deploying the project to the Render.com platform. diff --git a/docs/prompting-ai-agents.md b/docs/prompting-ai-agents.md new file mode 100644 index 0000000..a635c55 --- /dev/null +++ b/docs/prompting-ai-agents.md @@ -0,0 +1,17 @@ +# Prompting AI Agents for `attogram/base` Projects + +When using AI agents to create or update a repository based on `attogram/base`, clear and specific instructions are crucial for a successful outcome. This guide provides a template and details to help you craft effective prompts. + +## The Ideal Intro-Prompt + +Here is an easy-to-copy introduction that you can add to the beginning of your own prompts. This will give the AI agent the core context it needs to work within the `attogram/base` philosophy. + +``` +This project builds upon the attogram/base template. Please integrate the new website content without removing the core base repository files or structure. + +The main homepage for the site is `README.md`, and all new content should be linked from there. You can create new directories for your content as needed, but please do not modify the core `base` files and directories (such as `.github`, `docs`, `docker`, etc.). + +Please use the existing Jekyll setup for the site, which builds from the root directory. Do not install other static site generators like Eleventy. + +Finally, please look for and follow any instructions in an `AGENTS.md` file, as it contains project-specific guidelines for AI agents. +```