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

Improve Zebra documentation for beta release #2870

Closed
4 tasks
Tracked by #2867
conradoplg opened this issue Oct 13, 2021 · 1 comment · Fixed by #2894
Closed
4 tasks
Tracked by #2867

Improve Zebra documentation for beta release #2870

conradoplg opened this issue Oct 13, 2021 · 1 comment · Fixed by #2894
Assignees
Labels
C-enhancement Category: This is an improvement

Comments

@conradoplg
Copy link
Collaborator

conradoplg commented Oct 13, 2021

Motivation

For the beta release, we should improve the Zebra documentation (README and Zebra Book) a bit, to make it easier for an end-user to setup and run Zebra.

Specifications

Designs

Requirements:

  • The first or second sentence of the README must explain what Zebra does, in terms that most people will understand
  • The README should also explain how Zebra is different from zcashd.

Suggestions:

  • The home page / README (Getting Started) and the User Documentation section have similar information, but Getting Started it's a bit more detailed. This can get confusing if the user sees the sidebar and goes directly to the (leaner) User Documentation. Not sure if we should move most of Getting Started to the User Documentation
  • Describe Zebra in more detail (what it does, why does it exists, etc.) in the "About" at the beginning of the home page / README

Some suggestions moved to #2972

Related Work

@conradoplg conradoplg added C-enhancement Category: This is an improvement S-needs-triage Status: A bug report needs triage labels Oct 13, 2021
@mpguerra
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: This is an improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants