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

Add system prompt(s) documentation to README #12

Open
thibaultyou opened this issue Sep 30, 2024 · 0 comments
Open

Add system prompt(s) documentation to README #12

thibaultyou opened this issue Sep 30, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@thibaultyou
Copy link
Owner

Description

We need to update the README to include documentation for system prompts, specifically the metadata and view prompts. This will improve clarity and consistency in the project, especially as more prompts may be added to the system prompts in the future.

Currently, the README only provides the path to the current prompt. We should separate the system prompts from others and update the README to provide more detailed information about these prompts.

Steps to Implement

  1. Identify all existing system prompts (currently, the AI prompt analyzer and output generator).
  2. Create a new section in the README specifically for system prompts.
  3. For each system prompt, add:
    • A brief description of its purpose
    • The path to the prompt file
    • Any relevant usage information
  4. Update the "How It Works" section to mention the system prompts and their role in the project.
  5. Review and adjust the overall structure of the README to ensure the new information fits seamlessly.

Expected Behavior

  • The README should have a clear section dedicated to system prompts.
  • Each system prompt should be well-documented with its purpose and location.
  • The documentation should be easy to update as new system prompts are added.

Additional Information

This change will make it easier for contributors to understand the role of system prompts in the project and how they can be customized or extended.

@thibaultyou thibaultyou added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 30, 2024
@thibaultyou thibaultyou self-assigned this Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant