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.

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

docs: Move code samples to files and other updates #340

Merged
merged 2 commits into from
Jan 29, 2025
Merged

docs: Move code samples to files and other updates #340

merged 2 commits into from
Jan 29, 2025

Conversation

vdusek
Copy link
Contributor

@vdusek vdusek commented Jan 28, 2025 •
edited
Loading

Description

  • Relocated all code samples to dedicated files for being able to perform static analysis.
  • Updated home page example and moved it to a dedicated file.
  • Updated pyproject.toml configurations to include only directories with source files (website/ is added there, same as in Crawlee and SDK).
  • Revised most of the documentation content.
  • All code examples, where it makes sense, are both in sync & async forms.

Issues

Testing

  • All code samples pass checks with Ruff and Mypy.

Checklist

  • CI passed

@vdusek vdusek added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 28, 2025
@vdusek vdusek added this to the 107th sprint - Tooling team milestone Jan 28, 2025
@vdusek vdusek requested review from janbuchar and Pijukatel January 28, 2025 12:34
@vdusek vdusek self-assigned this Jan 28, 2025
@vdusek vdusek requested a review from TC-MO as a code owner January 28, 2025 12:34
@vdusek vdusek merged commit fb8514b into master Jan 29, 2025
28 checks passed
@vdusek vdusek deleted the update-docs branch January 29, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pijukatel Pijukatel Pijukatel approved these changes

@janbuchar janbuchar Awaiting requested review from janbuchar

@TC-MO TC-MO Awaiting requested review from TC-MO TC-MO is a code owner

Assignees

@vdusek vdusek

Labels
t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Milestone
107th sprint - Tooling team
Development

Successfully merging this pull request may close these issues.

Move code samples to separate files and revise the whole docs
2 participants
@vdusek @Pijukatel