Skip to content

Adjust grammar and spelling #95

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adjust grammar and spelling #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ This repository contains the software packages and dependencies to install and r

## Overview

Subgraph Uncrashable is a code generation framework that subgraph developers can integrate into their repository for safe subgraph development and upgrades. The tool generates a set of helper functions from the graphql schema of the tool to esnure that all interactions with entities in subgraphs are completely atomic.
Subgraph Uncrashable is a code generation framework that subgraph developers can integrate into their repositories for safe subgraph development and upgrades. The tool generates a set of helper functions from the graphql schema of the tool to ensure that all interactions with entities in subgraphs are completely atomic.

Common problems seen repeatedly in subgraph development are issues of loading undefined entities, not setting or initializing all values of entities, and race conditions on loading and saving entities, respectively. Mishandled entities cause subgraphs to crash, which can be very disruptive for projects that are dependent on the graph. Unavailability of subgraphs can result in unavailability of the overall system and adverse business impacts.
Common developer mistakes seen repeatedly in development of subgraphs are issues of loading undefined entities, not setting or initializing all values of entities, and race conditions on loading and saving entities, respectively. Mishandled entities cause your subgraph to crash, which can be very disruptive for projects that are dependent on the graph. The unavailability of a subgraph can result in the unavailability of the overall system and adverse business impacts.

The code generation is also configurable to set default values and configure the level of security checks that suits individual projects’ needs. Additionally, the tool can notify the users whenever there is a breach or potential breach of subgraph logic security and help them patch these issues. More info on this in the 'Usage' section.
The code generation is also configurable to set default values and configure the level of security checks that suits individual projects’ needs. Additionally, the tool can notify the users whenever there is a breach or potential breach of subgraph logic security and help them patch these issues. More info on this is in the 'Usage' section.

Integrate with Subgraph Uncrashable to make your subgraph "uncrashable" and ensure continuous uptime.
Integrate with Subgraph Uncrashable to make your subgraph fool-safe and ensure continuous uptime.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Subgraph Uncrashable by Float is a complementary tool to an existing subgraph th

## Uncrashable Config

Once your subgraph is in place, Subgraph Uncrashable can be used to create helper functions for your entities to ensure your subgraph doesn't crash.
Once your subgraph is in place, Subgraph Uncrashable can be used to create helper functions for your entities to ensure your entities function as intended.

Below is an example `uncrashable-config.yaml` file for the [gravatar example subgraph](https://github.com/graphprotocol/example-subgraph).

Expand Down