docs: separate shared style guide from repo-specific config#2304
Open
marcel-rbro wants to merge 6 commits intomasterfrom
Open
docs: separate shared style guide from repo-specific config#2304marcel-rbro wants to merge 6 commits intomasterfrom
marcel-rbro wants to merge 6 commits intomasterfrom
Conversation
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>
3 tasks
|
Preview for this PR was built for commit |
|
Preview for this PR was built for commit |
…dards in AGENTS.md
|
Preview for this PR was built for commit |
…ty and consistency
|
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
Separate general Apify writing style rules from repository-specific Markdown/Docusaurus conventions to
enable future reuse across other Apify teams.
content-standards.md into writing-style.md
images)
After this PR, general files (
writing-style.md,grammar-rules.md,terminology.md) contain norepo-specific content and can be extracted into a shared repository. Repo-specific files
(
content-standards.md,file-organization.md,quality-standards.md) stay here.