docs: fix style guide violations in platform documentation #2243
+232
−231
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix 324 style guide violations across 66 platform documentation files: - Replace em dashes (—) with hyphen with spaces ( - ) for consistency - Add descriptive titles to all admonitions (:::note, :::tip, :::caution, etc.) - Convert gerund headings (-ing forms) to imperative or noun forms - Convert Title Case headings to sentence case These changes ensure full compliance with Apify documentation style guide standards for readability, consistency, and accessibility. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
Fix remaining capitalization errors from previous commit: - Capitalize "Actor" and "Actors" in all headings (proper product name) - Capitalize "Standby mode" as proper feature name - Capitalize "I" in "How do I" questions - Capitalize text after "Step X:" and "Option X:" in headings These follow the Apify terminology guide where Actor is always capitalized as it's a proper product name, and sentence case rules require capitalizing the first word after colons in step/option headings. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
Fix all 41 issues identified in Opus review: - Replace double-spaced hyphens ( - ) with single-spaced ( - ) - Fix remaining em dash in store.md - Capitalize "Actor" in image alt text (3 instances) - Capitalize proper nouns in headings: Slack, TikTok, Zap, Google Sheets, GitHub Actions, Bad Gateway - Capitalize "Actor" in module names - Capitalize Option letters (A, B, C) - Fix remaining gerund headings (Extending → Extend, Resetting → Reset) - Fix grammatical issues (Monitor and tracking → Monitor and track) - Restore correct heading (Report process → Reporting process) - Capitalize script names in Step headings All changes ensure compliance with Apify terminology guide and sentence case standards for headings. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
Apply all corrections from PR #2243 review comments across entire codebase: Module/Product name capitalization: - Restore proper caps for Make.com modules: "Run an Actor", "Get Dataset Items", "Create Spreadsheet Rows", "Watch Actor Runs" - Restore module names: "Standard Settings Module", "Advanced Settings Module" - Fix product names: GitHub Actions, Google Sheets, Apify Console, Apify Store, Apify Proxy MCP capitalization: - Use "MCP server" (lowercase 's') in prose and headings - Keep "MCP Server" only in code strings and UI field names UI element names: - Capitalize: Build, Timeout, Memory (these are UI element names) Feature names: - "Restricted Access" when referring to the feature - "Data Source" in Keboola integration Revert example data changes: - Restore original capitalization in sample outputs (mastra.md) - Restore em dashes in JSON examples (amazon.md, instagram.md) Additional systematic fixes: - Fix "Apify console" → "Apify Console" (3 files) - Fix "Github" → "GitHub" (integrate_with_apify.md) - Fix "Apify Platform" → "Apify platform" (proxy/usage.md) - Fix "first actor" → "first Actor" (build_with_ai.md) All changes ensure product names, module names, and UI elements are properly capitalized per Apify style guide and user feedback. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Fix 4 remaining issues from final review: 1. maps.md: Fix heading capitalization - "Search" lowercase, "Leads" capitalized in product name "Google Maps Leads Scraper" 2. windmill.md: Restore "Windmill Hub" product name capitalization 3. n8n/index.md: Fix inconsistent "Node" capitalization - use lowercase "node" consistently across all headings 4. zapier.md: Fix "Finished Actor Run" to "Finished Actor run" for consistency with "Finished task run" All changes ensure proper sentence case with correct capitalization of product names and consistent terminology throughout. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
Preserve proper nouns, product names, UI elements, and module names while keeping generic terms lowercase per reviewer feedback. Co-Authored-By: Claude Opus 4.6 <[email protected]>
Fix table column alignment in runs_and_builds.md and correct reCaptcha → reCAPTCHA in console/index.md. Co-Authored-By: Claude Opus 4.6 <[email protected]>
marcel-rbro
commented
Feb 12, 2026
sources/platform/actors/development/deployment/continuous_integration.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/deployment/continuous_integration.md
Outdated
Show resolved
Hide resolved
sources/platform/actors/development/quick-start/start_locally.md
Outdated
Show resolved
Hide resolved
Normalize table pipe spacing for MD060 compliance. Co-Authored-By: Claude Opus 4.6 <[email protected]>
|
Preview for this PR was built for commit |
Align table pipes consistently for MD060 compliance. Co-Authored-By: Claude Opus 4.6 <[email protected]>
|
Preview for this PR was built for commit |
1 similar comment
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fix 324 style guide violations across 66 platform documentation files to ensure full compliance with Apify documentation style guide standards.
Changes
Files modified
66 files in
sources/platform/directory including:Quality checks
🤖 Generated with Claude Code
Note
Low Risk
Docs-only edits (headings/punctuation/admonition titles) with no product logic changes; risk is limited to potential broken anchors/links if headings are referenced elsewhere.
Overview
Applies broad documentation-only style-guide cleanups across platform docs (Actors, integrations, proxy, storage, console, collaboration).
Changes primarily standardize heading phrasing/case (e.g., gerunds to imperative, sentence case), normalize punctuation (replace em dashes with spaced hyphens), and add short titles to previously untitled admonitions, with a few minor wording/capitalization tweaks (e.g.,
reCAPTCHA,Apify Console,MCP server).Written by Cursor Bugbot for commit 0e18d97. Configure here.