Skip to content

[DOCS-3587] docs: Remove CLI commands from README#396

Merged
jrodewig merged 2 commits intomainfrom
update-readme
Oct 16, 2024
Merged

[DOCS-3587] docs: Remove CLI commands from README#396
jrodewig merged 2 commits intomainfrom
update-readme

Conversation

@jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Oct 15, 2024

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

  • Update the README to point folks to the Fauna Docs.
  • Remove related scripts for updating the README.

Preview

https://github.com/fauna/fauna-shell/blob/update-readme/README.md

@jrodewig jrodewig changed the title [DOCS-3587] Remove CLI commands from fauna-shell README [DOCS-3587] docs: Remove CLI commands from README Oct 15, 2024
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/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should talk about what process/tools we could have to keep these in sync moving forwards

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jrodewig jrodewig merged commit a04bfad into main Oct 16, 2024
@jrodewig jrodewig deleted the update-readme branch October 16, 2024 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants