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 README with better document structure and addition of sections with more high-level explanations. #49

Open
andre-senna opened this issue Oct 24, 2024 · 0 comments · Fixed by #60
Assignees

Comments

@andre-senna
Copy link
Contributor

An example of "use case" of the mentioned "high level" documentations is the first paragraph in the description of this issue: https://github.com/orgs/singnet/projects/6/views/1?pane=issue&itemId=84663712&issue=singnet%7Cdas-query-engine%7C355

The mentioned issue could have been created to someone that doesn't have any previous knowledge about how DAS Node is designed and how it works. Put yourself in the boots of such person and think about how you'd like to see the documentation structured and which information you'd like to read there.

Another "use-case" which should drive the same exercise is someone being assigned to this other issue: #48

@Pedrobc89 Pedrobc89 linked a pull request Dec 11, 2024 that will close this issue
@Pedrobc89 Pedrobc89 reopened this Dec 11, 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 a pull request may close this issue.

2 participants