Add some requested CLI cookbook entries #840
Conversation
BlaineHeffron
changed the title
|
Preview is available here: |
This comment was marked as off-topic.
This comment was marked as off-topic.
|
Preview is available here: |
|
LGTM, just added a couple of small comments |
|
@BlaineHeffron Ideally this could be in a single markdown file called cookbooks.mdx, with different paths for each recipe. |
|
@BlaineHeffron I was thinking that this Cookbook.mdx could be added to the CLI repo next to the FULL_HELP_DOCS.md and we could copy it over the docs, similar to the CLI Manual is copied over: #755 |
|
@janewang Makes sense, I'll work on getting that set up. |
|
Preview is available here: |
2 similar comments
|
Preview is available here: |
|
Preview is available here: |
|
Something went wrong with PR preview build please check |
|
@janewang I opened a draft PR for a Cookbook.md file. stellar/stellar-cli#1541 I also added to the script an entry to copy over this Cookbook.md file to |
|
Something went wrong with PR preview build please check |
1 similar comment
|
Something went wrong with PR preview build please check |
|
Hey @BlaineHeffron The other file that's being copied over is this file: https://github.com/stellar/stellar-cli/blob/main/FULL_HELP_DOCS.md. I think we only need these two files to be copied. |
|
Something went wrong with PR preview build please check |
|
Something went wrong with PR preview build please check |
|
This PR can only be merged after stellar/stellar-cli#1541 is merged. In that PR I moved the guide mdx files to the CLI repo in a new /docs directory. In this PR I altered the script to copy over the mdx files from the /docs directory. |
|
Something went wrong with PR preview build please check |
|
Preview is available here: |
|
Something went wrong with PR preview build please check |
|
Preview is available here: |
1 similar comment
|
Preview is available here: |
|
You can run |
|
The problem is that I needed to add the |
|
Something went wrong with PR preview build please check |
|
Preview is available here: |
|
Hi, friends!! Sorry, i'm late to the party here, had a couple hectic weeks. Can I get a little more context about what brought this change about? I think I've picked up on reasonably on what is taking place in this change, but I'm a little unclear about the why. Is there a particular reason having these cookbook guides live alongside the CLI codebase is better off than having them live in the docs? One of the reasons I'm asking is: now we're seeing the same broken link error Blaine mentioned in this comment if we're just using Thanks! |
|
Redacted. |
|
There is a test that runs through the commands to make sure that they are valid on the CLI side. That test could only reasonably live in the CLI repo. That's why Blaine created the file on the CLI side and copied over to the docs. Can someone point me to the broken links on the docs side? I heard it was mentioned but didn't see the links. |
|
Thank you @briwylde08! |
8 participants
Addresses stellar/stellar-cli#1438
Adds cookbook entries for:
We cannot yet do the following because the commands are not available on the CLI: