feat: creation of a new export command for rdme-compatible files#1468
Merged
Conversation
erunion
requested review from
domharrington,
flinehan,
jamestclark,
julshotal and
mosesj-readme
erunion
commented
May 16, 2026
|
|
||
| import { branchFlag, keyFlag } from './flags.js'; | ||
|
|
||
| type Section = 'Changelog' | 'Custom Pages' | 'Guides' | 'Reference'; |
Member
Author
There was a problem hiding this comment.
The export command currently only supports guides and references but because our upload command supports changelogs and custom pages I added some initial scaffolding throughout this work to eventually support those too.
domharrington
approved these changes
May 18, 2026
erunion
pushed a commit
that referenced
this pull request
May 18, 2026
# [10.9.0-next.1](v10.8.0...v10.9.0-next.1) (2026-05-18) ### Features * creation of a new `export` command for rdme-compatible files ([#1468](#1468)) ([2ab6109](2ab6109)) [skip ci]
Member
Author
|
🎉 This PR is included in version 10.9.0-next.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Member
Author
|
🎉 This PR is included in version 10.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🧰 Changes
This creates new
rdme docs exportandrdme reference exportcommands that when used will export rdme-compatible files that you can then re-sync wtihrdme docs uploadandrdme reference upload.The reason we're creating this new command is that due to the way rdme and our Git bidirectional sync offering works, files in bidi are not directly compatible with rdme because rdme files do not have awareness of where it should live within the clients directory and sidebar structures. This product difference requires files synced with rdme to have their frontmatter heading be ReadMe API payloads -- a difference that has caused a number of issues with customers migrating to ReadMe Refactored.
When invoked, this command will download all guides and reference pages, and if they are not empty, store them in a supplied directory in the same fashion that they may be stored in a bidirectional sync repository.
Huge thanks to @rossrdme for the work he did in writing the original script that powers this work, I just put the rdme sauce on top.
🧬 QA & Testing
This is what it looks like: