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

Update glossary.mdx #552

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

wise4rmgod
Copy link

I added the following definition to the Glossary page

  • Substreams
  • Firehose
  • Substreams-powered subgraph

Vince and the content team at Pinax have reviewed these definitions.

I also made grammatical changes to some definitions.

I added the following definition to the Glossary page
- Substreams
- Firehose
- Substreams-powered subgraph

Vince and the content team at Pinax have reviewed these definitions.

I also made grammatical changes to some definitions.
@wise4rmgod wise4rmgod requested a review from a team as a code owner December 4, 2023 14:18

- **Hosted service**: A temporary scaffold service for building and querying subgraphs as The Graph's decentralized network is maturing its cost of service, quality of service, and developer experience.
- **Substreams**: Allows developers to define the data Firehose should retrieve from the blockchain and apply transformations to it.
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like this definition is missing a noun, i.e. what is it exactly, not just what it allows?


- **Substreams-powered subgraph**: Enables subgraph developers to leverage Substreams' high indexing speed and additional data by using Substreams modules as data sources.

- **Subgraph**: A custom API built on blockchain data that can be queried using [GraphQL](https://graphql.org/). Developers can build, deploy, and publish subgraphs to The Graph's decentralized network. Then, Indexers can begin indexing subgraphs to make them available to be queried by subgraph consumers.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think Subgraph should at least be above Substreams-powered subgraph, but probably above Firehose and Substreams as well, right?

Copy link
Author

Choose a reason for hiding this comment

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

Initially, I wanted to make this page Alphabetical; if that were in line, I would fix it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that's a good idea. @MichaelMacaulay, what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

That's a great idea, go for it!

Copy link
Author

Choose a reason for hiding this comment

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

I will start working on it, thanks.

Copy link
Author

Choose a reason for hiding this comment

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

I have worked on the Alphabetical task; kindly review it.

Copy link
Author

Choose a reason for hiding this comment

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

@MichaelMacaulay I am waiting for your feedback on this task.

Copy link
Author

Choose a reason for hiding this comment

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

@benface Any update on this task?

Copy link
Contributor

Choose a reason for hiding this comment

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

@wise4rmgod – Can you please fix the conflicts and I'll review this again?

I converted the Glossary to an Alphabetical order
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