Skip to content

Conversation

@patrikbraborec
Copy link
Contributor

@patrikbraborec patrikbraborec commented Aug 4, 2025

The pull request introduces a new prompt component and documentation for AI-assisted coding.

@patrikbraborec patrikbraborec marked this pull request as ready for review August 5, 2025 07:51
@patrikbraborec patrikbraborec requested a review from TC-MO as a code owner August 5, 2025 07:51
@apify-service-account
Copy link

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

@cursor
Copy link

cursor bot commented Aug 5, 2025

Bugbot found 3 bugs

To see them, have a team admin activate your membership in the Cursor dashboard.

@apify-service-account
Copy link

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

@cursor
Copy link

cursor bot commented Aug 5, 2025

🚨 Bugbot Trial Expired

Your team's Bugbot trial has expired. Please contact your team administrator to turn on the paid plan to continue using Bugbot.

A team admin can activate the plan in the Cursor dashboard.

@apify-service-account
Copy link

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

@patrikbraborec
Copy link
Contributor Author

@TC-MO thanks a lot of a quick review, and good points. The last thing is with the change of title from Vibe coding to Build with AI.

From my point of view, I like the Build with AI title more than Vibe coding, and also other documentation (Astro, Stripe, etc.) use Build with AI, or similar variations.

@jancurn are you are OK with the title Build with AI? I know that you mention in the slack that you would prefer Vibe coding.

@TC-MO
Copy link
Contributor

TC-MO commented Aug 6, 2025

For what it's worth I took a deep dive after this review to double check it, and couldn't find any documentation that would refer to this practice as Vibe coding , it's always some variaton of Build with AI, AI optimization, Build with LLMs

Examples:

I would strongly recommend Build with AI or some variation thereof and don't mention vibe coding in docs

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.

A few small things I noticed

@jancurn
Copy link
Member

jancurn commented Aug 6, 2025

Sure, we can keep "Build with AI" just make sure to use the term "vibe coding" in the description bellow for SEO

@apify-service-account
Copy link

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

@jancurn
Copy link
Member

jancurn commented Aug 6, 2025

BTW I find the links to sitemap.xml and robots.txt confusing, they are more prominent than the actual llms.txt links - I'd get rid of them and just list a table like:

File Purpose
docs.apify.com/llms.txt Contains index of the docs page in Markdown, with links to all subpages in Markdown.
docs.apify.com/llms-full.txt Contains a full dump of documentation in Markdown.

On top of that, each individual documentation page is available also in Markdown, by adding the .md to the URL. For example https://docs.apify.com/platform => https://docs.apify.com/platform.md

@TC-MO
Copy link
Contributor

TC-MO commented Aug 6, 2025

The table doesn't have any links. I think it serves as a nice explanation of differences between those 3 files.

We'll definitely add info about making it a .md page

@jancurn
Copy link
Member

jancurn commented Aug 6, 2025

But when looking how to vibe code with Apify, why do I need to get a "lecutre" about robots.txt and sitemap ? It adds confusion rather than clarity

@apify-service-account
Copy link

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

@cursor
Copy link

cursor bot commented Aug 6, 2025

Bugbot found 2 bugs

To see them, have a team admin activate your membership in the Cursor dashboard.

@apify-service-account
Copy link

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

@patrikbraborec
Copy link
Contributor Author

@TC-MO , @jancurn

I removed the info about site.xml and robots.txt. I agree, it was extra info. I added explanation of llms.txt and llms-full.txt instead.

I also added a paragraph about markdown pages (this should be later updated once we have buttons as we discussed on slack).

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.

2 final notes after that it LGTM

@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Aug 7, 2025

Thanks, done
.

@apify-service-account
Copy link

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

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, one final comment, but more of a question than anything to change

/>
</CardGrid>

## Build with AI
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason why not H3? I thought it would fit nicely as a separate developer path.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The main reason is that the Start Locally in Your IDE and Start in Apify Web IDE are mode step-by-step tutorials where you finish with Actor. The Build with AI is more like things we have to support you in building Actors. Therefore, I tried to divide it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm I guess that is true, we could maybe ponder if it shouldn't then fall under Start locally but as far as I am concerned we can do it at later date. thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks!

@patrikbraborec
Copy link
Contributor Author

So, are we ready to merge it?

@TC-MO
Copy link
Contributor

TC-MO commented Aug 7, 2025

All engines go from my side, approval etc

@patrikbraborec patrikbraborec merged commit f38231d into master Aug 7, 2025
10 checks passed
@patrikbraborec patrikbraborec deleted the add/vibe-code-docs branch August 7, 2025 14:55
daveomri pushed a commit to daveomri/apify-docs that referenced this pull request Sep 3, 2025
Co-authored-by: Martin Adámek <[email protected]>
Co-authored-by: Michał Olender <[email protected]>
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.

6 participants