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

Rewrite future work section of the README before stable release #6872

Closed
oxarbitrage opened this issue Jun 8, 2023 · 3 comments · Fixed by #6935
Closed

Rewrite future work section of the README before stable release #6872

oxarbitrage opened this issue Jun 8, 2023 · 3 comments · Fixed by #6935
Assignees
Labels
A-docs Area: Documentation

Comments

@oxarbitrage
Copy link
Contributor

https://github.com/ZcashFoundation/zebra#future-work

The Zebra team is currently working towards an audited stable release.

We will continue to add new features as part of future network upgrades, and in response to community feedback.

The first sentence need to be removed and the second one maybe adjusted for new goals ?

@oxarbitrage oxarbitrage added the A-docs Area: Documentation label Jun 8, 2023
@teor2345
Copy link
Collaborator

teor2345 commented Jun 8, 2023

Let's replace the first part with a link to the audit report when it has been published?
We might want to put it in the section that links to the specifications.

For the second part I know our next goal is #6642, but we haven't decided what comes after that. Do we want to keep an up to date list of goals in the readme, or is there a better place for it? Like blog posts?

@mpguerra mpguerra linked a pull request Jun 13, 2023 that will close this issue
6 tasks
@mpguerra mpguerra self-assigned this Jun 13, 2023
@mpguerra
Copy link
Contributor

Let's replace the first part with a link to the audit report when it has been published? We might want to put it in the section that links to the specifications.

For the second part I know our next goal is #6642, but we haven't decided what comes after that. Do we want to keep an up to date list of goals in the readme, or is there a better place for it? Like blog posts?

I would remove the first sentence and leave the second sentence as is. It's ok to keep it vague and not keep updating our goals as they change. If we want to be more transparent I think there are better ways to do so than updating a sentence at the end of our README :)

@teor2345
Copy link
Collaborator

This was done in PR #6877.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants