Skip to content

docs: improve guides consistency#845

Merged
vdusek merged 1 commit intomasterfrom
docs/consistency-improvements
Mar 27, 2026
Merged

docs: improve guides consistency#845
vdusek merged 1 commit intomasterfrom
docs/consistency-improvements

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Mar 27, 2026 •
edited
Loading

Summary

  • Fix inlined code examples in Introduction and Quick Start
  • Standardize all guides to follow the same pattern: intro paragraph, Introduction, Example Actor, Conclusion, Additional resources
  • Move "Running webserver" from concepts to guides in v1.7 and v2.7
  • Add linked library names, Apify template links, and official documentation references to all guides
  • Update quick-start links to guides and concepts

Test plan

  • Executed locally and manually checked
  • CI passes
@vdusek @claude
docs: Improve guide consistency across all documentation versions
1b79ffd 
Standardize the structure and content of all guide articles across all four documentation versions (current, v3.3, v2.7, v1.7). - Ensure every guide starts with "In this guide, you'll learn..." intro with linked library names - Add "Introduction" and "Conclusion" section headings to all guides - Add "Additional resources" section with relevant Apify templates, official documentation, and GitHub repository links - Move "Running webserver" article from concepts to guides in v1.7 and v2.7 for consistency with newer versions - Renumber remaining concept files to maintain sequential ordering - Update quick-start "Next steps" links across all versions - Extract inline code examples into dedicated .py files with docstrings Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Mar 27, 2026
@vdusek vdusek self-assigned this Mar 27, 2026
@github-actions github-actions bot added this to the 137th sprint - Tooling team milestone Mar 27, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 27, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.64%. Comparing base (ed13597) to head (1b79ffd).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files 
@@ Coverage Diff @@ ## master #845 +/- ## ========================================== - Coverage 86.67% 86.64% -0.04%  ========================================== Files 48 48 Lines 2920 2920 ========================================== - Hits 2531 2530 -1  - Misses 389 390 +1
Flag Coverage Δ
e2e 37.87% <ø> (ø)
integration 59.28% <ø> (-0.04%) ⬇️
unit 74.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
@vdusek vdusek changed the title docs: improve guide consistency across all documentation versions docs: improve guide consistency Mar 27, 2026
@vdusek vdusek changed the title docs: improve guide consistency docs: improve guides consistency Mar 27, 2026
@vdusek vdusek merged commit d7a44ef into master Mar 27, 2026
31 checks passed
@vdusek vdusek deleted the docs/consistency-improvements branch March 27, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

2 participants

@vdusek @apify-service-account