Add draft style guide for the docs site#6001
Draft
mostafaNazari702 wants to merge 1 commit into
Draft
Conversation
AI was used responsibly to refine and restructure my original notes into a clearer, more readable format while following the conventions of a Markdown (.md) file. Co-authored-by: ChatGPT-4o <noreply@openai.com>
Contributor
Author
|
@mark-wiemer @JoshuaKGoldberg |
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
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.
PR Checklist
status: accepting prsOverview
Opening this as a draft first to get feedback/approval before doing any larger follow-up renames.
I cooked a short docs style guide in
.github/STYLE.mdto address #5446 and document the conventions the docs already mostly follow. each rule includes real "good" and "bad" examples pulled from the current docs in the latest main branch.It covers stuff like:
js,bash,ts)the goal isnt to invent a brand-new style guide but rather to formalize existing patterns and resolve a few places where the docs are currently inconsistent.
no existing docs are modified yet so review stays focused and low-noise. if the direction looks good i can follow up with separate cleanup PRs for the inconsistencies mentioned at the bottom of the file.
Main feedback I'm looking for:
.github/STYLE.mdthe right location?P.S. AI (GPT-4o) was used responsibly to refine and restructure my original notes into a clearer, more readable format while following the conventions of a Markdown (.md) file.