Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/2.0/reference/accountfactory/configurations-as-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,16 @@ account_factory {
</HclListItemDescription>
</HclListItem>

### pr_create_token_name

<HclListItem name="pr_create_token_name" requirement="optional" type="string">
<HclListItemDescription>

(GitHub only) The name of your PR create token if different from the default of `PR_CREATE_TOKEN`.

Comment on lines +323 to +327
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Address markdownlint MD046 on the description line.

Line 326 is being parsed as an indented code block by markdownlint. Please reformat this description so it’s treated as normal prose (e.g., wrap in <p>...</p> or remove leading indentation for the text line).

Suggested fix
 <HclListItem name="pr_create_token_name" requirement="optional" type="string">
   <HclListItemDescription>
-
-    (GitHub only) The name of your PR create token if different from the default of `PR_CREATE_TOKEN`.
-
+    <p>(GitHub only) The name of your PR create token if different from the default of <code>PR_CREATE_TOKEN</code>.</p>
   </HclListItemDescription>
 </HclListItem>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<HclListItem name="pr_create_token_name" requirement="optional" type="string">
<HclListItemDescription>
(GitHub only) The name of your PR create token if different from the default of `PR_CREATE_TOKEN`.
<HclListItem name="pr_create_token_name" requirement="optional" type="string">
<HclListItemDescription>
<p>(GitHub only) The name of your PR create token if different from the default of <code>PR_CREATE_TOKEN</code>.</p>
</HclListItemDescription>
</HclListItem>
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 326-326: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/2.0/reference/accountfactory/configurations-as-code.md` around lines 323
- 327, The HclListItemDescription for HclListItem name="pr_create_token_name" is
being interpreted as an indented code block (markdownlint MD046); fix it by
changing the description line so it’s normal prose—either remove the leading
indentation on the text line or wrap the description in a paragraph tag (e.g.,
use <p>...</p>) within the HclListItemDescription block so the text is parsed as
regular markdown.

</HclListItemDescription>
</HclListItem>

### security_account_name

<HclListItem name="security_account_name" requirement="optional" type="string">
Expand Down