Skip to content

Commit

Permalink
Improve docs for dockerfiles prompts
Browse files Browse the repository at this point in the history
  • Loading branch information
slimslenderslacks committed Jul 4, 2024
1 parent 3eb8d71 commit 988477a
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions prompts/dockerfiles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,29 @@ functions:
description: whether to make the file executable
container:
image: vonwig/function_write_files:latest
- name: docker_scout_tag_recommendation
description: get a recommended tag
parameters:
type: object
properties:
repository:
type: string
description: the name docker image repository
container:
image: vonwig/function_docker_scout_tag_recommendations:latest
---

# Background

These prompts are designed for an assistant to author a Dockerfile.

* the [user prompts](100_user_prompt.md) direct the assist to extract details about the project, and then write a Dockerfile to the root of the project.
* the [npm best practices](npm-best-practices.md) is are added to the system prompts whenever the assist detects that this is an NPM project.

## functions

These instructions in these prompts rely on 3 functions

1. `analyze_project` - requires read-only access to the project and extracts details from the project to give the assistant context for authoring the Dockerfile
2. `write_files` - has read-write access to the project and will write Dockerfiles so that developers don't have to copy and paste data out of a chat.
3. `docker_scout_tag_recommendation` - uses Docker Scout to improve the choice tag selection during code generation.

0 comments on commit 988477a

Please sign in to comment.