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

Cody prompting guide #367

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Cody prompting guide #367

wants to merge 5 commits into from

Conversation

chris-sev
Copy link

@chris-sev chris-sev commented May 29, 2024

Adding a Cody Prompting Guide that shows best practices for getting the most out of Cody

Contains 2 sections:

  • Preparation: Writing good code and comments
  • Prompting: How to talk to Cody and bring in specific info + context

Still to do

  • Add a link to this page somewhere
  • Upload images

Images

I wasn't sure how to upload images to Google Storage so I'm adding them here. The filenames correspond with the IMAGE HERE: image-name.jpg sections in the markdown file.

cody-mention-snippet
cody-mention-file
cody-document-code

Copy link

vercel bot commented May 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 19, 2024 8:59pm
sourcegraph-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 19, 2024 8:59pm

Copy link
Collaborator

@MaedahBatool MaedahBatool left a comment

Choose a reason for hiding this comment

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

Hey @chris-sev thanks a ton for contributing these docs. Left some minor suggestions. Let me know your thoughts about it. :)

docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
docs/cody/core-concepts/prompting-guide.mdx Outdated Show resolved Hide resolved
@MaedahBatool
Copy link
Collaborator

hey @chris-sev catching up on this PR? Are we still doing this?

@toolmantim
Copy link
Contributor

This is great! Would be good to include @-mentioning files in your instructions when using edit code (opt-k)

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.

3 participants