Skip to content

docs: Add RapidAPI guide #2015

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
Merged
merged 17 commits into from
Oct 20, 2025
Merged

docs: Add RapidAPI guide #2015

merged 17 commits into from
Oct 20, 2025

Conversation

patrikbraborec
Copy link
Contributor

No description provided.

@patrikbraborec patrikbraborec requested a review from TC-MO October 15, 2025 07:52
@github-actions github-actions bot added the t-c&c Team covering store and finance matters. label Oct 15, 2025
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

@honzajavorek
Copy link
Collaborator

Thanks for new content! I see you're adding this to the Academy, but in the future we'd like the main section of Academy to contain only courses, i.e. something larger that consists of a series of lessons, where the reader works on building something (ideally also learning something by accident 😄).

This looks more like a how-to guide, which, in my mind, fits better to the Tutorials section. That section needs more love and the structure is TBD, but I'd still put this content there. What do you think?

btw, I see a change to the package-lock.json in a PR which isn't otherwise related to tooling, just adding new content. Is that intentional? When working on content, I personally use npm ci to avoid upgrading something accidentally.

@patrikbraborec
Copy link
Contributor Author

Hi @honzajavorek. Thanks for the feedback. I moved it to tutorials. Let me know what do you think, thank you!

@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

honzajavorek
honzajavorek requested changes Oct 16, 2025
View reviewed changes
Copy link
Collaborator

@honzajavorek honzajavorek left a comment

Choose a reason for hiding this comment

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

Awesome, thank you! I performed a thorough review, left a lot comments, but please don't feel intimidated. They're mostly nitpicks. In fact I found no really serious issues! My summary:

  • I'm unsure if we want to write tutorials as "you" or "we". That's something we should discuss with @TC-MO. I have no strong opinions, it's more a matter of (future) consistency.
  • Admonitions are almost there, I'd add one more and improve some of the existing ones.
  • At places, English could be improved.
  • Some code examples have wrong highlighting.
  • I tried to suggest improvements to the apify push part, so that we carry people over the login trap more carefully.
  • I suggested consistent use of bold for UI elements.
  • I'm unsure about the .mdx / .md extensions

@patrikbraborec
Copy link
Contributor Author

Hi @honzajavorek, thanks! I'll check it.

At places, English could be improved.

It was checked by our content team, so I assumed it would be OK, but if you think it needs improvement, let's do it. :)

@honzajavorek
Copy link
Collaborator

It was checked by our content team

Aaah, well, I'm no native speaker nor English expert, I'll be honest about that 😄 I wrote some suggestions according to how I feel it, but it's up to you if you think they're something to address or if you discard them. The whole text is a good job overall, it's comprehensible as is, so take those English grammar/style comments just as nitpicks and feel free to jump over them.

patrikbraborec and others added 5 commits October 17, 2025 12:07
@patrikbraborec @honzajavorek
Update sources/academy/tutorials/apify_actors/adding_rapidapi_project…
768405a 
….mdx

Co-authored-by: Honza Javorek <mail@honzajavorek.cz>
@patrikbraborec @honzajavorek
Update sources/academy/tutorials/apify_actors/adding_rapidapi_project…
60a8f41 
….mdx

Co-authored-by: Honza Javorek <mail@honzajavorek.cz>
@patrikbraborec @honzajavorek
Update sources/academy/tutorials/apify_actors/adding_rapidapi_project…
7ee7c0d 
….mdx

Co-authored-by: Honza Javorek <mail@honzajavorek.cz>
@patrikbraborec @honzajavorek
Apply suggestions from code review
0a4e13c 
Co-authored-by: Honza Javorek <mail@honzajavorek.cz>
@patrikbraborec @honzajavorek
Apply suggestions from code review
ae5b81c 
Co-authored-by: Honza Javorek <mail@honzajavorek.cz>
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

TC-MO
TC-MO requested changes Oct 17, 2025
View reviewed changes
@apify-service-account
Copy link

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

@patrikbraborec
Copy link
Contributor Author

@TC-MO @honzajavorek thanks for the review, I think that everything is fixed.

TC-MO
TC-MO requested changes Oct 17, 2025
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I noticed few more things:

  • reworded description and intro sentence - this is just a suggestion
  • consistency in naming - would be nice to have
  • removal of the - this is per Apify style guide, IIRC we do not use the before Apify Console

patrikbraborec and others added 2 commits October 17, 2025 16:32
@patrikbraborec @TC-MO
Apply suggestions from code review
6894a09 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@patrikbraborec
docs: Fix PR comments
a4e8ed0
@apify-service-account
Copy link

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

@apify-service-account
Copy link

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

honzajavorek
honzajavorek reviewed Oct 17, 2025
View reviewed changes
Copy link
Collaborator

@honzajavorek honzajavorek left a comment

Choose a reason for hiding this comment

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

If Michał approves, it's good to go, i.e. don't wait for a re-review from me 🚀

@honzajavorek
Copy link
Collaborator

I didn't manage to remove myself as a reviewer in the GitHub mobile app. If my previous review blocks merging this, let me know and I'll rubber stamp this as approved, as a sacrifice to the GitHub UI.

@TC-MO
Copy link
Contributor

TC-MO commented Oct 17, 2025

I think your approve is required @honzajavorek since you've requested changes previously

@patrikbraborec patrikbraborec merged commit a16e001 into master Oct 20, 2025
9 checks passed
@patrikbraborec patrikbraborec deleted the docs/rapidapi-guide branch October 20, 2025 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@honzajavorek honzajavorek honzajavorek approved these changes

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

Assignees

@patrikbraborec patrikbraborec

Labels

t-c&c Team covering store and finance matters.

Projects

None yet

Milestone

125th sprint - Cash & Community team

Development

Successfully merging this pull request may close these issues.

4 participants

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