Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature request] ability to fetch single/multiple docs #582

Open
david-wolgemuth opened this issue Aug 24, 2022 · 1 comment
Open

[feature request] ability to fetch single/multiple docs #582

david-wolgemuth opened this issue Aug 24, 2022 · 1 comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request

Comments

@david-wolgemuth
Copy link

david-wolgemuth commented Aug 24, 2022

a couple misc feature requests packed in here,
would love a couple of the quick wins, and of course if a full-sync is coming, then +1

ability to fetch a doc (without editing it)

currently the rdme docs:edit command fetches an upstream doc and allows to make changes,

but, it only allows me to open the file in a terminal editor (i.e. vim) then upon closing the editor syncs back up

would like to have an option to fetch without updating on the spot,

something like:

rdme docs:get <my-slug> -o ./my-slug.md

ability to fetch all docs

get the list of all of the docs, and download them to a dir

rdme docs:list -o ./docs

(alternative - use the getcategorydocs endpoint)

https://docs.readme.com/reference/getcategorydocs

rdme category:docs <category-slug>
# out - json

full sync

obviously a big ask.. and I see @kanadgupta mentioned there may be some wip here #539 (comment)

but something like:

rdme docs:sync ./docs

tree ./docs
# ./docs
#     /category-a
#         - doc-a.md
#     /category-b
#         - doc-b.md
@kanadgupta kanadgupta added enhancement New feature or request command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Aug 24, 2022
@kanadgupta
Copy link
Member

Docs export improvements and bi-directional syncing are definitely on our radar! No time estimate at the moment unfortunately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants