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 for Prompts and Prompt Library #546

Merged
merged 6 commits into from
Aug 7, 2024

Conversation

MaedahBatool
Copy link
Collaborator

@MaedahBatool MaedahBatool commented Aug 6, 2024

Adds docs for the upcoming Prompts and the Prompt Library.

Copy link

vercel bot commented Aug 6, 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 Aug 7, 2024 8:54pm

@MaedahBatool MaedahBatool changed the title Docs working branch for the August 7th release Docs for Prompts and Prompt Library Aug 6, 2024
@MaedahBatool MaedahBatool requested a review from chenkc805 August 6, 2024 21:20
@MaedahBatool MaedahBatool self-assigned this Aug 6, 2024
@MaedahBatool MaedahBatool added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 6, 2024
@MaedahBatool
Copy link
Collaborator Author

@chenkc805, can you please review the content? I still need to add the images and videos, though. Waiting for Quinn to push recent UI changes.

@chenkc805
Copy link
Contributor

Thanks Maedah! I'm currently commuting so can't give in depth comments, but at a high level here's some feedback:

  • Let's make Prompts the primary, and Commands secondary.
  • Instances of "custom commands" should tie the idea that "custom commands" is being replaced by Prompts
  • Commands and Custom Commands are going to be replaced by Prompts and Prompt Library in the coming future
  • For the Cody quick start, can we do the following:
    • add generate an inline edit
    • add accept an autocomplete
    • add "@"mention a repo or file in a chat to give specific context
    • add create a prompt in your prompt library
    • take out generate unit tests, as this functionality doesn't perform well.

@MaedahBatool
Copy link
Collaborator Author

@chenkc805 thanks for the feedback. I have addressed all your feedback except for your suggestions on revamping the Quickstart guide. I totally agree with your proposal. I am taking it as a follow-up task for next week. Let's ship the docs for Prompts and Prompt library to unblock the release work and I can ship the improved Quickstart next week. :)

@MaedahBatool MaedahBatool marked this pull request as ready for review August 7, 2024 20:53
@MaedahBatool MaedahBatool merged commit b64af2a into sg-next-aug2024 Aug 7, 2024
7 checks passed
@MaedahBatool MaedahBatool deleted the prompts-and-library branch August 7, 2024 20:55
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

Successfully merging this pull request may close these issues.

2 participants