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

docs: packages and apps #28

Merged
merged 5 commits into from
Nov 8, 2024
Merged

docs: packages and apps #28

merged 5 commits into from
Nov 8, 2024

Conversation

0xkenj1
Copy link
Collaborator

@0xkenj1 0xkenj1 commented Nov 8, 2024

🤖 Linear

Closes GIT-118 GIT-119 GIT-120

Description

Improve docs across the entire the repo

Checklist before requesting a review

  • I have conducted a self-review of my code.
  • I have conducted a QA.
  • If it is a core feature, I have included comprehensive tests.

Copy link

linear bot commented Nov 8, 2024

GIT-118 Docs

@0xkenj1 0xkenj1 requested a review from 0xnigir1 November 8, 2024 01:56
0xnigir1
0xnigir1 previously approved these changes Nov 8, 2024
Copy link
Collaborator

@0xnigir1 0xnigir1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

byutiful, just super minor suggestions


### [StrategyRegistry](./src/strategyRegistry.ts)

The `StrategyRegistry` stores strategy IDs in memory to populate strategy events with them.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `StrategyRegistry` stores strategy IDs in memory to populate strategy events with them.
The `StrategyRegistry` stores strategy IDs to populate strategy events with them given the Strategy address.


### [DataLoader](./src/data-loader/dataLoader.ts)

The `DataLoader` is responsible for applying changesets to the database..
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `DataLoader` is responsible for applying changesets to the database..
The `DataLoader` is responsible for applying changesets to the database.

Describe your package's API here.
### Processors

This package provides the following repositories:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This package provides the following repositories:
This package provides the following events' processors:

Copy link

linear bot commented Nov 8, 2024

Copy link
Collaborator

@jahabeebs jahabeebs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

@0xkenj1 0xkenj1 merged commit b6b112e into dev Nov 8, 2024
6 checks passed
@0xkenj1 0xkenj1 deleted the docs/packages-and-apps branch November 8, 2024 17:52
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 this pull request may close these issues.

3 participants