Conversation
## 🧰 Changes minor rearranging of the docs as part of #1284. all of the docs that we're syncing now live in a `synced/` directory, and the legacy pages live in a subdirectory of that.
## 🧰 Changes - [x] rewrites `rdme.mdx` for a post-refactored world - [x] cleans up frontmatter (this is since we probably want to hide/shuffle things around in readme itself and this allows us to do it there!) - [x] add callout for category URI normalization - [x] add the category URI back to the main page once we determine where the page will be living
…create-a-copy-for-v10
kanadgupta
left a comment
kanadgupta
left a comment
There was a problem hiding this comment.
just pushed up a few finishing touches and revived a few CI things — i'm happy with this if you are @emilyskuo!
| - uses: readmeio/github-readme-sync@v2 | ||
| with: | ||
| readme-oas-key: <<user>>:API_DEFINITION_ID | ||
| readme-oas-key: API_KEY:API_DEFINITION_ID |
There was a problem hiding this comment.
i brought back alex checks for MDX files and it was getting tripped up by these <<whatever>> statements so i just ripped 'em out
|
|
||
| To see an example where multiple OpenAPI/Swagger files are synced in the same repository, check out [jesseyowell/oas-test-files](https://github.com/jesseyowell/oas-test-files). | ||
|
|
||
| </details> |
There was a problem hiding this comment.
similar thing down here — alex was expecting this
| @@ -1,7 +1,6 @@ | |||
| --- | |||
| title: 'GitHub Actions Example: Syncing Markdown' | |||
| category: | |||
There was a problem hiding this comment.
per what we discussed offline, i added the category to the main page (e.g., documentation/synced/rdme.mdx) but omitted it from everywhere else so as to keep the source of truth for that attribute in our bidirectionally-synced repo.
| @@ -1,10 +1,16 @@ | |||
| name: Sync `documentation` directory to ReadMe | |||
| name: Sync docs to ReadMe | |||
There was a problem hiding this comment.
all the changes in this file are so we can get rdme docs upload dry runs working again 🥳
emilyskuo
deleted the
emily/rm-13209-fork-main-rdme-docs-page-and-create-a-copy-for-v10
branch
| 🚥 Resolves RM-13246 | | :------------------- | ## 🧰 Changes updates the formatting for our `this.warn()` statements so they're surfaced properly in github actions annotations. - [x] make sure everything else is merged in and refresh this branch afterwards - [x] do a dry run with the CI changes in #1284 to ensure that warnings are surfaced properly ## 🧬 QA & Testing i confirmed that these are showing up properly: https://github.com/readmeio/rdme/actions/runs/16131074838/job/45518517159
|
🎉 This PR is included in version 10.4.0-next.8 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
) | 🚥 Resolves RM-13226, RM-13227 | | :------------------- | ## 🧰 Changes - [x] marks all page upload commands as stable - [x] updates migration guide to reflect command availability - [x] updates command descriptions to reflect new frontmatter format (will require links to the docs in #1284) ## 🧬 QA & Testing confirmed that all of the help screens and warnings are updated accordingly!
|
🎉 This PR is included in version 10.4.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
2 participants
🧰 Changes
Updates to our
rdmedocs to be synced to the ReadMe Docs. As part of thisrdme docs upload --dry-runruns on every pushalexrunning against MDX files again🧬 QA & Testing
do the docs look good?