fix: update rdme now that this is on superhub #1061
Conversation
| hidden: false | ||
| title: Callouts | ||
| category: | ||
| uri: syntax | ||
| metadata: |
There was a problem hiding this comment.
have you tried syncing locally? i thiiiink this metadata object shape this might cause issues with APIv2
There was a problem hiding this comment.
Oof yeah I tried this and it broke the markdown repo really bad (with no warning). I had to setup bidi and do a git revert from there to fix it.
There was a problem hiding this comment.
😬 yikes okay let me know if you need a hand! and if you have more info on what the breakage was, i'm happy to look into it! our API is rather strict about request payloads now so i would have expected it to throw rather than accept this and break stuff 😮💨
for add'l background, with the end of january sprint on this docs upload release, i didn't include metadata object in the initial list of fields to have migration logic for but i did create a test todo in the rdme repo to eventually backfill it. sounds like we should add that soon 🫠
There was a problem hiding this comment.
This is the revert commit! https://github.com/readmeio/rdmd-docs/commit/8a1c29f0075e3a6eb3aa7b539fab2dec1a3cef0d
The big thing I think was the Syntax and syntax folders that got created for some reason. I also think some of the frontmatter that got created might have been invalid? Not sure
There was a problem hiding this comment.
ah okay — none of the diff looks frontmatter-related so not sure. i suppose this repo is pretty much the worst case scenario when it comes to MDX issues since the whole point of these docs is to demonstrate and test the limits of our markdown support 🫠 we deemed MDX issues out-of-scope for this rdme release but might be good to explore in the future!
.github/workflows/release.yml
Outdated
| @@ -61,6 +61,6 @@ jobs: | |||
| # Sync docs to rdmd.readme.io | |||
| # | |||
| - name: Sync docs to rdmd.readme.io | |||
| uses: readmeio/rdme@v9 | |||
| uses: readmeio/rdme@next | |||
There was a problem hiding this comment.
| uses: readmeio/rdme@next | |
| uses: readmeio/rdme@v10.2.0-next.4 |
| with: | ||
| rdme: docs ./docs --key=${{ secrets.RDME_KEY }} --version=2 | ||
| rdme: docs upload ./docs --key=${{ secrets.RDME_KEY }} --version=2 |
There was a problem hiding this comment.
i heard rumblings that we're consolidating these docs into the main project but i believe this API key points to the markdown project!
🧰 Changes
Update the docs syncing to use rdme@next now that this project is on superhub!
🧬 QA & Testing