[DOCS-3587] docs: Remove CLI commands from README #396
Conversation
This file contains 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
jrodewig
requested review from
echo-bravo-yahoo,
mwilde345,
macmv and
ecooper
jrodewig
changed the title
fauna-shell README
Comment on lines
+46
to
+48
| For usage instructions and a full [list of | ||
| commands](https://docs.fauna.com/fauna/current/build/cli/commands/), see the | ||
| [Fauna docs](https://docs.fauna.com/fauna/current/build/cli/). |
There was a problem hiding this comment.
we should talk about what process/tools we could have to keep these in sync moving forwards
There was a problem hiding this comment.
My current process is to have a GitHub watch set up for this repo so that I'm aware of any PRs that come in.
I also get plugged in to planned working during sprint planning.
Happy to discuss other possibilities, but that's my MO for other repos (core, drivers, etc.). CC @ecooper.
echo-bravo-yahoo
approved these changes
Oct 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ticket(s): DOCS-3587
Problem
We currently document Fauna CLI commands in both the README and the Fauna Docs.
Previously, the README was automatically updated using scripts, but those scripts aren't reliable anymore.
Solution
Preview
https://github.com/fauna/fauna-shell/blob/update-readme/README.md