From 6a12038e9004e217fbee3989f5fc52adc069b52e Mon Sep 17 00:00:00 2001 From: iwantanode <87604944+tudorpintea999@users.noreply.github.com> Date: Sun, 12 Nov 2023 14:12:53 +0200 Subject: [PATCH] fix: several typos in the docs (#3533) --- ARCHITECTURE.md | 2 +- CONTRIBUTING.md | 4 ++-- README.md | 6 +++--- docs/DEVELOPMENT_ENVIRONMENT.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index d53a20da5c..64285daf03 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -23,7 +23,7 @@ Galoy relies on lnd to process transactions. The dependency of lnd, and bitcoind Currently Galoy relies on a single lnd instance, but the goal is to be able to manage several lnd instances at the same time, so that lnd can be recycled when needed, and also provide reliability when downtime is needed, or to provide multi-region redundancy. -Lnd itself is also adding etcd as another backend option to bring more resilicency; this will be another option when available that will bring more resiliency to Galoy +Lnd itself is also adding etcd as another backend option to bring more resiliency; this will be another option when available that will bring more resiliency to Galoy ### Main pods diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03445b388c..4d0dd150b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ type LightningError = import("./errors").LightningError #### Imported Library types -In the places where we would like to work with types defined in imported libraries, we have two options. When we would like to use them directly, we can simply import them. If we would like to re-use a type to create our own types, we would re-import to get those types into our declaration files. +In the places where we would like to work with types defined in imported libraries, we have two options. When we would like to use them directly, we can simply import them. If we would like to reuse a type to create our own types, we would re-import to get those types into our declaration files. For example, for a result type from the `lightning` library, we would import and re-use it like: ``` @@ -100,7 +100,7 @@ const myFunction = async ({ ``` #### Defining objects with methods -We use functional constructors to define certain types of objects that we can call method on. The intention here is to instantiate the object first and then call methods on that object with method-specific args to execute some functionality. +We use functional constructors to define certain types of objects that we can call methods on. The intention here is to instantiate the object first and then call methods on that object with method-specific args to execute some functionality. For objects like these, the interface for the object is defined using a `type` declaration and methods are typed at this point. diff --git a/README.md b/README.md index 9506df3cb0..00fd1c9f93 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Want to try it out and contribute? Check out the [dev documentation](./docs/DEVE If you have questions, you can [join our Workspace](https://chat.galoy.io) -For an overview of all relevant repository checkout [awesome-galoy](https://github.com/GaloyMoney/awesome-galoy). +For an overview of all relevant repositories checkout [awesome-galoy](https://github.com/GaloyMoney/awesome-galoy). ## Galoy-Backend features - GraphqlAPI: @@ -51,7 +51,7 @@ For an overview of all relevant repository checkout [awesome-galoy](https://gith - Include memo to payment - Lightning Network - Support for clearnet and TOR - - Support for invoices with and without specified amount + - Support for invoices with and without a specified amount - Route probing to pre-display an accurate fee and mitigate attacks based on expensive routing - Channel data backup to Dropbox and Google Cloud storage - Custodial storage of all user assets @@ -70,7 +70,7 @@ For an overview of all relevant repository checkout [awesome-galoy](https://gith - Supports horizontal scaling and highly available deployments via k8s - Client side load balancing across multiple LND nodes - Out-of-the-box dashboards for KPIs deployed to Grafana showing metrics exported via Prometheus - - Quick response times thanks to pagination of large data sets + - Quick response times thanks to the pagination of large data sets - Returning error codes for full translation capability of the frontend - Instrumentation enabled for real-time insights into production runtime ([opentelemetry](https://opentelemetry.io) / [honeycomb](https://www.honeycomb.io)) - User onboarding (optional) diff --git a/docs/DEVELOPMENT_ENVIRONMENT.md b/docs/DEVELOPMENT_ENVIRONMENT.md index 0625baeb47..232d6eb1b2 100644 --- a/docs/DEVELOPMENT_ENVIRONMENT.md +++ b/docs/DEVELOPMENT_ENVIRONMENT.md @@ -28,7 +28,7 @@ Using native Windows is not supported at this time. ### File Descriptor Limit -On some systems, you may need to significantly increasing the file descriptor limit for `buck2`. +On some systems, you may need to significantly increase the file descriptor limit for `buck2`. This is because `buck2` opens many more files than either `cargo` or `pnpm` do. Not only that, but when using Tilt to build and run concurrent services, even more files are opened than they would be for sequential builds.