Skip to content

Pull request for issue #23 #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
google-labs-jules wants to merge 1 commit into from
Closed

Pull request for issue #23 #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 17 additions & 0 deletions docs/prompting-ai-agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
```