doc: Add guides for prompting, AGENTS.md, and package.json #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds three new documentation files to the `/docs` directory to improve the user experience and provide clear guidance on working with the `attogram/base` template. The new files are: - `prompting-ai-agents.md`: A comprehensive guide on how to effectively prompt AI agents, with two distinct examples for using the template as-is or modifying it for a new technology stack. - `agents-md-guide.md`: A user-facing explanation of the purpose and usage of the `AGENTS.md` file. - `package-json-guide.md`: An explanation of the `package.json` and `package-lock.json` files used for development tooling. Additionally, the main `docs/README.md` has been updated to include links to these new guides.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds three new documentation files (
prompting-ai-agents.md,agents-md-guide.md,package-json-guide.md) and updates the maindocs/README.mdto link to them. This provides users with comprehensive guidance on working with AI agents, understanding theAGENTS.mdfile, and the purpose of thepackage.jsonfiles.