Skip to content

Commit 9888212

Browse files
authored
docs: small doc oversights (#1291)
## 🧰 Changes - [x] removes the docs page for `rdme changelogs` since that command is now deprecated - [x] fixes up a few examples in our docs
1 parent b88bb07 commit 9888212

File tree

3 files changed

+4
-52
lines changed

3 files changed

+4
-52
lines changed

documentation/commands/changelogs.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

documentation/synced/github-actions-openapi-example.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jobs:
6565
# Docs: https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#example-using-versioned-actions
6666
uses: readmeio/rdme@RDME_VERSION
6767
with:
68-
rdme: openapi ./path-to-file.json --key=${{ secrets.README_API_KEY }} --slug=API_DEFINITION_SLUG
68+
rdme: openapi upload ./path-to-file.json --key=${{ secrets.README_API_KEY }} --slug=API_DEFINITION_SLUG
6969
```
7070
7171
In the example above, every push to the `main` branch will sync the OpenAPI file located at `./path-to-file.json` to the API specification `API_DEFINITION_SLUG` in your ReadMe project.

documentation/synced/rdme.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,15 +221,15 @@ Follow these steps to manually configure a GitHub Actions Workflow. This will re
221221
The command syntax in GitHub Actions is functionally equivalent to the CLI. For example, take the following CLI command:
222222
223223
```sh
224-
rdme openapi validate [url-or-local-path-to-file]
224+
rdme openapi upload [url-or-local-path-to-file] --key=$README_API_KEY
225225
```
226226

227227
To execute this command via GitHub Actions, the step would look like this:
228228

229229
```yml
230230
- uses: readmeio/rdme@RDME_VERSION
231231
with:
232-
rdme: openapi validate [url-or-local-path-to-file]
232+
rdme: openapi upload [url-or-local-path-to-file] --key=${{ secrets.README_API_KEY }}
233233
```
234234
235235
The following section has links to full GitHub Actions workflow file examples.
@@ -346,7 +346,7 @@ If you're working with the Markdown upload commands (e.g., `docs upload`, `refer
346346
If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environmental variable to print helpful debugging info to the console:
347347

348348
```sh
349-
DEBUG=rdme* rdme openapi validate [url-or-local-path-to-file]
349+
DEBUG=rdme* rdme openapi upload [url-or-local-path-to-file] --key=...
350350
```
351351

352352
Note that this should only be used for development/debugging purposes and should not be enabled in production environments.

0 commit comments

Comments
 (0)