Skip to content

Commit 70fcf5c

Browse files
authored
docs: tweak YAML comments to fix TOC (#1328)
## 🧰 Changes noticed our TOC looks a lil off at the moment: <img width="1656" height="572" alt="CleanShot 2025-08-12 at 11 30 00@2x" src="https://github.com/user-attachments/assets/eef159df-1845-42ea-a77a-fca10ebfe485" /> turns out `oclif`'s autogenerated TOC generation was incorrectly thinking a YAML comment was a header. this fixes that!
1 parent 20a740a commit 70fcf5c

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ npm run build && npm run build:docs
4040
* [Quick Start](#quick-start)
4141
* [CLI Configuration](#cli-configuration)
4242
* [GitHub Actions Configuration](#github-actions-configuration)
43-
* [Required in order for the GitHub Action to access your repo's contents](#required-in-order-for-the-github-action-to-access-your-repos-contents)
44-
* [Runs the `rdme openapi validate petstore.json` command with the root directory being your repo](#runs-the-rdme-openapi-validate-petstorejson-command-with-the-root-directory-being-your-repo)
4543
* [Command Topics](#command-topics)
4644
<!-- tocstop -->
4745
<!-- prettier-ignore-end -->
@@ -147,10 +145,10 @@ rdme login
147145
`rdme` has a thin wrapper that allows the CLI to be used as a proper action in a GitHub Actions workflow. For example, say you wanted to run `rdme openapi validate petstore.json` in a GitHub Actions environment. Here's what the corresponding steps would look like in a GitHub Actions workflow file:
148146

149147
```yml
150-
# Required in order for the GitHub Action to access your repo's contents
148+
## Required in order for the GitHub Action to access your repo's contents
151149
- uses: actions/checkout@v4
152150

153-
# Runs the `rdme openapi validate petstore.json` command with the root directory being your repo
151+
## Runs the `rdme openapi validate petstore.json` command with the root directory being your repo
154152
- uses: readmeio/rdme@v10
155153
with:
156154
rdme: openapi validate petstore.json

0 commit comments

Comments
 (0)