Skip to content

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

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 3 commits into from
Jan 23, 2025
Merged

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

merged 3 commits into from
Jan 23, 2025

Conversation

vdusek
Copy link
Contributor

@vdusek vdusek commented Jan 22, 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).
  • Revised most of the documentation content.
  • Updated legacy examples (new imports, types, ...).
  • Added a new Crawlee guide.
  • Fixed the Crawlee Playwright example in the README.
  • The text in the Concepts section was remained as it is, only some minor updates there. Code samples were moved to separate files and corrected if necessary as was said before.
  • Ensured all examples in the documentation are fully executable, meeting the prerequisites for the upcoming "Run on Apify" feature.
  • The docs content files were renamed to undescore-based, in the same way as we have in Crawlee.

Issues

Testing

  • All code samples pass checks with Ruff and Mypy.

Checklist

  • CI passed

@github-actions github-actions bot added this to the 106th sprint - Tooling team milestone Jan 22, 2025
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 22, 2025
@vdusek vdusek requested review from janbuchar and Pijukatel January 22, 2025 18:51
This was referenced Jan 22, 2025
Closed
Merged
Pijukatel
Pijukatel reviewed Jan 23, 2025
View reviewed changes
janbuchar
janbuchar approved these changes Jan 23, 2025
View reviewed changes
Copy link
Contributor

@janbuchar janbuchar left a comment

Choose a reason for hiding this comment

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

I did not read this in depth, but it looks OK on a high level.

@vdusek vdusek merged commit cd8b05e into master Jan 23, 2025
28 checks passed
@vdusek vdusek deleted the update-docs branch January 23, 2025 09:56
@vdusek vdusek mentioned this pull request Jan 23, 2025
Merged
vdusek added a commit that referenced this pull request Jan 23, 2025
@vdusek
docs: fix links and some headings (#380)
de61ad5 
I broke some links in #378, so this update fixes them. Additionally,
there are some cosmetic changes, such as updating the titles to the
correct case format.
vdusek added a commit to apify/actor-templates that referenced this pull request Jan 23, 2025
@vdusek
chore: Update of Python templates (#310)
7623e5a 
A few minor updates to the Python templates that came to mind while
working on
[apify-sdk-python#378](apify/apify-sdk-python#378).
I wanted to propagate these updates here as well, as the templates are
closely aligned with the code used in the guides.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@janbuchar janbuchar janbuchar approved these changes

@Pijukatel Pijukatel Pijukatel approved these changes

Assignees

@vdusek vdusek

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

Successfully merging this pull request may close these issues.

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