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

Update README #513

Merged
merged 5 commits into from
Dec 12, 2024
Merged

Update README #513

merged 5 commits into from
Dec 12, 2024

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Dec 12, 2024

Ticket(s): DOCS-3890

Problem

The README is outdated and doesn't reflect the current experience.

Solution

Update the README. Feedback is welcome!

Result

Fresh docs!

Testing

  • Some npm commands, such as npm install -g fauna-shell@beta won't work until the package is live.
  • The links under "Documentation" won't work until the docs are published.

@jrodewig jrodewig requested a review from a team as a code owner December 12, 2024 14:53
Copy link
Contributor

@ptpaterson ptpaterson left a comment

Choose a reason for hiding this comment

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

Are CLI v3 and v4 pages both going to be available in docs site during beta?

@jrodewig
Copy link
Contributor Author

Are CLI v3 and v4 pages both going to be available in docs site during beta?

Good question — Yes. Both will be available until at least v4 GAs. Preview: https://deploy-preview-2732--fauna-docs.netlify.app/fauna/current/build/cli/v4/

Screenshot 2024-12-12 at 10 47 39 AM

@jrodewig jrodewig merged commit 531a17d into v3 Dec 12, 2024
4 checks passed
@jrodewig jrodewig deleted the revise-readme branch December 12, 2024 17:31
@cleve-fauna cleve-fauna mentioned this pull request Dec 13, 2024
@wildemat wildemat mentioned this pull request Dec 18, 2024
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.

3 participants