docs: fix style guide violations in platform documentation#2311
Merged
marcel-rbro merged 5 commits intomasterfrom Mar 5, 2026
Merged
docs: fix style guide violations in platform documentation#2311marcel-rbro merged 5 commits intomasterfrom
marcel-rbro merged 5 commits intomasterfrom
Conversation
Fix em dashes, gerund headings, title case headings, admonitions without titles, and terminology capitalization across 65 files in sources/platform/. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Preview for this PR was built for commit |
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Preview for this PR was built for commit |
These sections are being removed in a separate PR, so reverting the casing change here avoids merge conflicts. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Preview for this PR was built for commit |
TC-MO
approved these changes
Mar 5, 2026
Contributor
TC-MO
left a comment
TC-MO
left a comment
There was a problem hiding this comment.
Apart from:
- FAQ that we discussed
- Troubleshooting
LGTM
"Troubleshooting" is a ubiquitous expression and should not be converted to the imperative form. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 style guide violations across 65 platform documentation files.
Files modified
65 files in
sources/platform/including actors, integrations, storage, proxy, console, collaboration, and schedules documentation.🤖 Generated with Claude Code
Note
Low Risk
Docs-only wording/formatting updates with no code or behavior changes; risk is limited to minor link/anchor or rendering regressions from heading text changes.
Overview
Applies a broad docs-only style cleanup across ~65
sources/platform/pages to align with the documentation style guide.Changes include converting gerund/title-case headings to sentence-case imperative forms, replacing em dashes with spaced hyphens, adding titles to untitled admonitions, and normalizing terminology/capitalization (e.g.,
Apify Console,MCP server,webhook).Written by Cursor Bugbot for commit a111eed. Configure here.