Skip to content

chore: align docs with Apify writing style guide#44

Merged
vystrcild merged 1 commit into
mainfrom
chore/writing-style-guide-fixes
Apr 28, 2026
Merged

chore: align docs with Apify writing style guide#44
vystrcild merged 1 commit into
mainfrom
chore/writing-style-guide-fixes

Conversation

@vystrcild
Copy link
Copy Markdown
Collaborator

Summary

  • Apply Apify's writing style guide to all skill docs and READMEs
  • Sentence case for headings (was: title case)
  • Capitalize Actor / Actors when used as a noun
  • Drop the article before product names: Apify Console, Apify Store (no "the")
  • Add the article before the Apify platform where missing
  • Typo fixes: confirmsconforms, javascriptJavaScript
  • Code blocks, CLI commands, file paths, and JSON values were left untouched

17 files changed, 144 insertions, 144 deletions.

Test plan

  • Skim each modified file and confirm headings, Actor capitalization, and product-name article usage match the writing style guide
  • Verify no code blocks, CLI commands, file paths, or JSON values were modified

Apply sentence case to headings, capitalize Actor as a noun, drop the
article before "Apify Console" / "Apify Store", add the article before
"the Apify platform", and fix a few typos ("confirms" -> "conforms",
"javascript" -> "JavaScript"). Code blocks, CLI commands, file paths,
and JSON values are unchanged.
@vystrcild vystrcild requested a review from lukas-bekr April 28, 2026 11:41
Copy link
Copy Markdown
Contributor

@lukas-bekr lukas-bekr left a comment

Choose a reason for hiding this comment

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

All good 👍🏻

Copy link
Copy Markdown
Collaborator

@MQ37 MQ37 left a comment

Choose a reason for hiding this comment

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

👍

@vystrcild vystrcild merged commit 179b7d8 into main Apr 28, 2026
2 checks passed
@vystrcild vystrcild deleted the chore/writing-style-guide-fixes branch April 28, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants