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

feature: add diagrams for Data access Layer #954

Open
SuccinctPaul opened this issue Jan 27, 2024 · 0 comments
Open

feature: add diagrams for Data access Layer #954

SuccinctPaul opened this issue Jan 27, 2024 · 0 comments

Comments

@SuccinctPaul
Copy link
Contributor

🌟 Feature Request

  • add table description of datebases's tables
  • add state-diagram for winness, proof, and scheduler etc tables.

📝 Description

To provide a more clear and concise description of Data access Layer. Better to have the different diagrams of tables and their state transfer. As there are lots of services using the databases.

🤔 Rationale

  1. Easier to understand data workflow managed in DAL.
  2. Easier to debug.
  3. Easier to maintain and add features for guys who wanna leverage the power of zkStack.
@SuccinctPaul SuccinctPaul changed the title feat: add more detail docs for Data access Layer feat: add diagrams for Data access Layer Jan 27, 2024
@SuccinctPaul SuccinctPaul changed the title feat: add diagrams for Data access Layer feature: add diagrams for Data access Layer Jan 27, 2024
github-merge-queue bot pushed a commit that referenced this issue Mar 18, 2024
## What ❔

add docs and diagrams for dal.


## Why ❔
Easier to understand data workflow managed in DAL.
Easier to debug.
Easier to maintain and add features for guys who wanna leverage the
power of zkStack.

* #954

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [ ] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [ ] Tests for the changes have been added / updated.
- [ ] Documentation comments have been added / updated.
- [ ] Code has been formatted via `zk fmt` and `zk lint`.
- [ ] Spellcheck has been run via `zk spellcheck`.
- [ ] Linkcheck has been run via `zk linkcheck`.
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

No branches or pull requests

1 participant