Skip to content
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.

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

docs: document system prompt design changes #41

Merged

Conversation

MichaelRoytman
Copy link
Member

Description

This commit adds documentation for changes to the system prompt design. It includes an Architecture Decision Record (ADR) detailing our proposed changes to the way we store the system prompt as well as instructions for how to properly modify the system prompt with this new design.

@MichaelRoytman MichaelRoytman force-pushed the michaelroytman/COSMO-114-system-prompt-changes-adr branch 3 times, most recently from 8d7fc86 to 098daee Compare December 13, 2023 13:36
Copy link
Member

@alangsto alangsto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One nit, but otherwise this looks great! Thanks for putting so much detail into both documents.


* Changes to the system prompt will require pull requests to the appropriate repository in which the prompt is stored.
* Anyone with access to the appropriate repository in which the prompt is stored can change the system prompt. Members
* of the team will no longer require assistance from the SRE team.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this should be indented instead of bulleted.

This commit adds documentation for changes to the system prompt design. It includes an Architecture Decision Record (ADR) detailing our proposed changes to the way we store the system prompt as well as instructions for how to properly modify the system prompt with this new design.
@MichaelRoytman MichaelRoytman force-pushed the michaelroytman/COSMO-114-system-prompt-changes-adr branch from 098daee to 79585c0 Compare December 14, 2023 14:23
@MichaelRoytman MichaelRoytman merged commit 5b11adb into main Dec 14, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants