Skip to content

docs: Add quick start prompt to the docs #1734

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 11 commits into from
Closed

docs: Add quick start prompt to the docs #1734

wants to merge 11 commits into from

Conversation

@patrikbraborec
Copy link
Contributor

@patrikbraborec patrikbraborec commented Jul 28, 2025 •
edited
Loading

The PR adds a button to copy a prompt for quick start.

Important:

  • Only quick demo to open discussion. It would need probably little bit improve the prompt, add analytics to measure click rate, etc.

@patrikbraborec patrikbraborec requested a review from TC-MO as a code owner July 28, 2025 13:38
@patrikbraborec patrikbraborec changed the title Add quick start prompt to the docs docs: Add quick start prompt to the docs Jul 28, 2025
cursor[bot]
cursor bot reviewed Jul 28, 2025
View reviewed changes
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Comment bugbot run to trigger another review on this PR

@apify-service-account
Copy link

apify-service-account commented Jul 28, 2025

Preview for this PR was built for commit 8cf0cd8 and is ready at https://pr-1734.preview.docs.apify.com!

@TC-MO
Copy link
Contributor

TC-MO commented Jul 28, 2025 •
edited
Loading

As I understand it is supposed to be a prompt for LLMs (or rather Agent since it needs to execute actions) right? Why not show it to people and offer copy abilitiy? To offer them just a copy button with CTA feels like not the best UX

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Jul 28, 2025

To be honest, I got the inspiration in the Clerk's doc as I quite liked it: https://clerk.com/docs/quickstarts/nextjs.

If I understand your suggestion, you would show the whole prompt (for example with "accordion" - https://ui.shadcn.com/docs/components/accordion, or other UI element), let users read the prompt, and let them decide if they want to copy it, or not?

@TC-MO
Copy link
Contributor

TC-MO commented Jul 28, 2025

Yeah exactly :) I definitely see the value, it just feels wrong to give the user ability to copy something without previously see it/read it.

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Jul 29, 2025

Yeah, I think that is a good point. I will redesign the component.

Base automatically changed from improve/quick-start to master July 30, 2025 10:37
@patrikbraborec patrikbraborec force-pushed the improve/quick-start-prompt branch from 8cf0cd8 to 4344bce Compare July 30, 2025 10:44
@apify-service-account
Copy link

apify-service-account commented Jul 30, 2025

Preview for this PR was built for commit 4344bce and is ready at https://pr-1734.preview.docs.apify.com!

@apify-service-account
Copy link

apify-service-account commented Jul 30, 2025

Preview for this PR was built for commit c05c95f and is ready at https://pr-1734.preview.docs.apify.com!

@apify-service-account
Copy link

apify-service-account commented Jul 30, 2025

Preview for this PR was built for commit ecfb02d and is ready at https://pr-1734.preview.docs.apify.com!

@apify-service-account
Copy link

apify-service-account commented Jul 30, 2025

Preview for this PR was built for commit 223c240 and is ready at https://pr-1734.preview.docs.apify.com!

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Jul 30, 2025

You can check it @TC-MO. Do you know, if it is possible to add analytics (i.e. to measure click events on the copy prompt button)?

TC-MO
TC-MO reviewed Jul 30, 2025
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

Looks nice ,and thank you for adding the ability to see the prompt ;) 🚀

@TC-MO
Copy link
Contributor

TC-MO commented Jul 30, 2025

As for the analytics, I think this is a request for @jbartadev

@apify-service-account
Copy link

apify-service-account commented Jul 30, 2025

Preview for this PR was built for commit d02eb38 and is ready at https://pr-1734.preview.docs.apify.com!

TC-MO
TC-MO approved these changes Jul 30, 2025
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

LGTM

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Jul 30, 2025

Thanks for the approve, @TC-MO. The next steps:

  • I want to add event to measure clicks on copy prompts. The reason for that is that it can give us insights about usage of such a "feature".
  • I want to also test the prompt in other environments, I only tested it briefly with Cursor.

Therefore, I will wait with merge. :) Thanks!

@apify-service-account
Copy link

apify-service-account commented Jul 31, 2025

Preview for this PR was built for commit 7397b437 and is ready at https://pr-1734.preview.docs.apify.com!

@apify-service-account
Copy link

apify-service-account commented Jul 31, 2025

Preview for this PR was built for commit 25f1949d and is ready at https://pr-1734.preview.docs.apify.com!

@apify-service-account
Copy link

apify-service-account commented Jul 31, 2025

Preview for this PR was built for commit 57c2df49 and is ready at https://pr-1734.preview.docs.apify.com!

@apify-service-account
Copy link

apify-service-account commented Jul 31, 2025

Preview for this PR was built for commit 019e8782 and is ready at https://pr-1734.preview.docs.apify.com!

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Jul 31, 2025 •
edited
Loading

@TC-MO just FYI, I added the analytics, and tested the prompt with several models. I will also post this for feedback in #product-development as this is quite a new approach, and it will be good to get feedback before merge. I will keep you updated about it.

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Aug 5, 2025

Closing, will merge it as part of #1756

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursor cursor[bot] cursor[bot] left review comments

@TC-MO TC-MO TC-MO approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@patrikbraborec @apify-service-account @TC-MO