Skip to content

Commit d5ca840

Browse files
committed
format rules correctly
1 parent 5b438d8 commit d5ca840

2 files changed

Lines changed: 3 additions & 9 deletions

File tree

STYLE_RULES.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,7 @@ Interpret these labels consistently:
6161
* `Preferred` means use this by default, but it can be overridden for clarity or local context
6262
* `Avoid` means do not do this unless there is a specific reason
6363

64-
Section-specific guides override this document when they are more specific. For
65-
example, Wallets documentation has its own contributing guide at
66-
`content/wallets/CONTRIBUTING.md`. In those docs, follow the Wallets-specific
67-
rules first and use this guide as the fallback for anything not covered there.
64+
Section-specific guides override this document when they are more specific. For example, Wallets documentation has its own contributing guide at `content/wallets/CONTRIBUTING.md`. In those docs, follow the Wallets-specific rules first and use this guide as the fallback for anything not covered there.
6865

6966
Some choices in this repo are enforced by tooling such as Prettier, ESLint, and markdown linting. This guide should not duplicate those checks. It should cover the places where judgment matters: what to say, how to organize it, and how much to explain.
7067

content/wallets/CONTRIBUTING.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66

77
**ROLE**: You are helping write documentation for Alchemy's Smart Wallets product. Always follow these rules when generating or editing content.
88

9-
**PRECEDENCE**: These rules override the repo-wide style guide in
10-
[`STYLE_RULES.md`](../../STYLE_RULES.md) for content under `content/wallets/`.
9+
**PRECEDENCE**: These rules override the repo-wide style guide in [`STYLE_RULES.md`](../../STYLE_RULES.md) for content under `content/wallets/`.
1110

1211
**CORE PRINCIPLES**:
1312

@@ -34,9 +33,7 @@
3433

3534
When writing or editing documentation for Alchemy Smart Wallets, follow these comprehensive style guidelines. These rules ensure consistency, clarity, and developer-focused content that abstracts away blockchain complexity.
3635

37-
**Scope**: These guidelines extend the repo-wide style guide in
38-
[`STYLE_RULES.md`](../../STYLE_RULES.md). If a Wallets-specific rule conflicts
39-
with the repo-wide guide, follow this document for Wallets content.
36+
**Scope**: These guidelines extend the repo-wide style guide in [`STYLE_RULES.md`](../../STYLE_RULES.md). If a Wallets-specific rule conflicts with the repo-wide guide, follow this document for Wallets content.
4037

4138
**Foundation**: Follow the [Google Developer Documentation Style Guide](https://developers.google.com/style) as the base standard.
4239

0 commit comments

Comments
 (0)