Skip to content

feat: lesson about docs driven development - #2537

Merged
honzajavorek merged 8 commits into
masterfrom
honzajavorek/docs-driven-scraping
Aug 3, 2026
Merged

feat: lesson about docs driven development#2537
honzajavorek merged 8 commits into
masterfrom
honzajavorek/docs-driven-scraping

Conversation

@honzajavorek

@honzajavorek honzajavorek commented May 15, 2026

Copy link
Copy Markdown
Collaborator

This PR adds a new lesson to the AI-first course. Given the secrets I share in the lesson, I expect no less than all our technical writers to start behaving like all-powerful rulers of the world after reading. Because that's who they rightfully are, after being handed an AI agent as their magic wand. This is my genuine expectation and not at all a strategy to lure you into reviewing! The "docs first" movement has been dormant for a decade, but now we've got weapons!

image

@honzajavorek
honzajavorek requested a review from szaganek as a code owner May 15, 2026 15:01
@honzajavorek honzajavorek added the t-academy Issues related to Web Scraping and Apify academies. label May 15, 2026
@honzajavorek
honzajavorek marked this pull request as draft May 15, 2026 15:01
@apify-service-account

apify-service-account commented May 15, 2026

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@honzajavorek
honzajavorek force-pushed the honzajavorek/docs-driven-scraping branch from cab8751 to e30113a Compare May 19, 2026 14:20
@honzajavorek
honzajavorek marked this pull request as ready for review May 20, 2026 09:29
@honzajavorek

Copy link
Copy Markdown
Collaborator Author

Also... after @TC-MO noted under the past PR that we actually have some guidelines on screenshots, I've read them and to my surprise, we should use orange for highlighting the elements and no arrows! I tried to actually comply this time :awkward-monkey:

@TC-MO

TC-MO commented May 20, 2026

Copy link
Copy Markdown
Contributor

That is actually a fairly recent change coupled with our new visual initiative driven by @szaganek

@szaganek szaganek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not gonna lie, the PR title lured me in ✨

Comment thread sources/academy/platform/scraping_with_apify_and_ai/03_docs_driven_prompting.md Outdated
Comment thread sources/academy/platform/scraping_with_apify_and_ai/03_docs_driven_prompting.md Outdated
Comment thread sources/academy/platform/scraping_with_apify_and_ai/03_docs_driven_prompting.md Outdated
Comment thread sources/academy/platform/scraping_with_apify_and_ai/03_docs_driven_prompting.md Outdated
Comment thread sources/academy/platform/scraping_with_apify_and_ai/03_docs_driven_prompting.md Outdated
Comment thread sources/academy/platform/scraping_with_apify_and_ai/03_docs_driven_prompting.md Outdated

In the Apify interface, we'll click the **Start** button. Soon we should see items popping up in the **Output** section.

Thanks to the sentence "The Actor output schema ensures that Apify interface shows saved items in the best way," the agent improved how our Actor talks to Apify, so we don't have to switch to **All fields** anymore:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
Thanks to the sentence "The Actor output schema ensures that Apify interface shows saved items in the best way," the agent improved how our Actor talks to Apify, so we don't have to switch to **All fields** anymore:
Thanks to the sentence The Actor output schema ensures that Apify interface shows saved items in the best way”, the agent improved how our Actor talks to Apify, so we don't have to switch to **All fields** anymore:

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I like correct quotation marks very much...

(I don't want to brag, but I'm such a recognized fan of https://www.zoul.cz/uvozovky/ that the author has dedicated the page to me in the footnote)

...but I had a hunch that our contribution guidelines prefer the straight ones: " Which, to my surprise, is actually not the case, at least now when I checked! 🙀

So, challenge accepted. If we wanna play the Correct Quotes Game from now on, I guess I'll have to add a linter for it 😎

@honzajavorek
honzajavorek force-pushed the honzajavorek/docs-driven-scraping branch from 6c524c2 to 6e61039 Compare July 31, 2026 14:42
@honzajavorek

Copy link
Copy Markdown
Collaborator Author

@szaganek All addressed, thanks! With your suggestions, the result is much better 🙇‍♂️

@honzajavorek
honzajavorek merged commit fd51112 into master Aug 3, 2026
16 checks passed
@honzajavorek
honzajavorek deleted the honzajavorek/docs-driven-scraping branch August 3, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-academy Issues related to Web Scraping and Apify academies.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants