Update style-guide.mdx

[Nicca42]

The American formatting of dates is incredibly confusing to the international audience.

I highly recommend we update to the more accessible yyyy/mm/dd which also has the added benefit of automatically sorting any dated files by recent to oldest.

[netlify]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	cce0f5f
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/6728d86c4eb0e80008306daf
😎 Deploy Preview	https://deploy-preview-1070--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a comprehensive style guide for writing technical content for Optimism Docs. It includes a metadata block for SEO and accessibility, a structured Table of Contents, and various sections covering naming conventions, writing style, accessibility guidelines, meta tags, content types, and general formatting rules. The guide aims to enhance the clarity, organization, and accessibility of the documentation.

Changes

File Path	Change Summary
pages/connect/contribute/style-guide.mdx	Added a comprehensive style guide with metadata, structured sections on writing conventions, accessibility, and formatting guidelines.

Possibly related PRs

• Update style guide to align with MS guide #945: The changes in this PR directly relate to the style guide for Optimism Docs, enhancing clarity and consistency in documentation, which aligns with the comprehensive style guide introduced in the main PR.

Suggested reviewers

• krofax

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.