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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add information in the main README #9

Open
1 of 4 tasks
brunomenezes opened this issue Jun 6, 2023 · 0 comments
Open
1 of 4 tasks

Add information in the main README #9

brunomenezes opened this issue Jun 6, 2023 · 0 comments
Labels
type:docs Improvements or additions to documentation

Comments

@brunomenezes
Copy link
Collaborator

brunomenezes commented Jun 6, 2023

馃搫 Context

  • Reporting a typo.
  • Reporting a documentation bug.
  • Documentation improvement.
  • Documentation feedback.

Is there a specific documentation page you are reporting?

Main README documentation

Additional context or description

It is important to provide information about the repository for whoever lands on the repository page.

As a starter:

  • How the repository is structured.
  • Links to the other packages that may or may not have their own README's.
  • How we release new versions of the subgraph packages.
@brunomenezes brunomenezes added the type:docs Improvements or additions to documentation label Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Improvements or additions to documentation
Projects
Status: 馃搶 Todo
Development

No branches or pull requests

1 participant