Skip to content

docs: separate shared style guide from repo-specific config#2304

Merged
marcel-rbro merged 11 commits intomasterfrom
docs/separate-style-guide-rules
Mar 10, 2026
Merged

docs: separate shared style guide from repo-specific config#2304
marcel-rbro merged 11 commits intomasterfrom
docs/separate-style-guide-rules

Conversation

@marcel-rbro
Copy link
Contributor

@marcel-rbro marcel-rbro commented Mar 3, 2026

Summary

Separate general Apify writing style rules from repository-specific Markdown/Docusaurus conventions to
enable future reuse across other Apify teams.

  • Move general formatting rules (headings, bold, italics, links, numbers, parallel structure) from
    content-standards.md into writing-style.md
  • Extract grammar mechanics into new grammar-rules.md
  • Refocus content-standards.md on Markdown/Docusaurus specifics (front matter, admonitions, code blocks,
    images)

After this PR, general files (writing-style.md, grammar-rules.md, terminology.md) contain no
repo-specific content and can be extracted into a shared repository. Repo-specific files
(content-standards.md, file-organization.md, quality-standards.md) stay here.

marcel-rbro and others added 2 commits March 3, 2026 11:27
Extract grammar mechanics into a new grammar-rules.md file covering
hyphenation, contractions, e.g./i.e., numbers, list punctuation, and
brand spelling. Refocus writing-style.md on voice and tone by removing
formatting sections that duplicate content-standards.md. Add article
usage rules for Apify products, crawler/scraper capitalization, and
US vs British English patterns to the shared style guide files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add grammar-rules.md references to README, instructions, quality
checklist, and review skill. Update file descriptions across all
config files to reflect the new separation of concerns. Restructure
review-docs skill to use subagent delegation for style compliance
checks against individual rules files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added the t-docs Issues owned by technical writing team. label Mar 3, 2026
@apify-service-account
Copy link

Preview for this PR was built for commit f7e492b3 and is ready at https://pr-2304.preview.docs.apify.com!

@marcel-rbro marcel-rbro marked this pull request as ready for review March 3, 2026 12:49
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

Few things to change, some questions.

Also maybe we could add argument-hint & allowed-tool to frontmatter of skills?

More on those: here

@apify-service-account
Copy link

Preview for this PR was built for commit 2d3abbad and is ready at https://pr-2304.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit b85d50e6 and is ready at https://pr-2304.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 31171aad and is ready at https://pr-2304.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit e8c11cb4 and is ready at https://pr-2304.preview.docs.apify.com!

@marcel-rbro marcel-rbro requested a review from TC-MO March 5, 2026 10:47
@danpoletaev danpoletaev force-pushed the docs/separate-style-guide-rules branch from e8c11cb to 9626210 Compare March 6, 2026 21:56
@apify-service-account
Copy link

Preview for this PR was built for commit 96262104 and is ready at https://pr-2304.preview.docs.apify.com!

@metalwarrior665 metalwarrior665 force-pushed the docs/separate-style-guide-rules branch from 9626210 to e8c11cb Compare March 7, 2026 00:02
@apify-service-account
Copy link

Preview for this PR was built for commit e8c11cb4 and is ready at https://pr-2304.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 51031878 and is ready at https://pr-2304.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 8d816750 and is ready at https://pr-2304.preview.docs.apify.com!

Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

Just a minor nit otherwise, LGTM

marcel-rbro and others added 2 commits March 10, 2026 12:57
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@apify-service-account
Copy link

Preview for this PR was built for commit 21bc12cf and is ready at https://pr-2304.preview.docs.apify.com!

@apify-service-account
Copy link

Preview for this PR was built for commit 21bc12cf and is ready at https://pr-2304.preview.docs.apify.com!

@marcel-rbro marcel-rbro merged commit 4c56090 into master Mar 10, 2026
13 checks passed
@marcel-rbro marcel-rbro deleted the docs/separate-style-guide-rules branch March 10, 2026 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-docs Issues owned by technical writing team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants