Merge pull request #6486 from IntersectMBO/fix/docs-typos-squashed

carbolymer · web-flow · commit 126efd54008b · 2026-03-13T09:42:46.000Z
Fix typos and minor issues in documentation and comments
diff --git a/.github/ISSUE_TEMPLATE/node_release.md b/.github/ISSUE_TEMPLATE/node_release.md
@@ -44,7 +44,7 @@ flowchart BT
 - [ ] Plutus Ledger API is integrated into the Ledger.
 - [ ] Ledger is integrated into the Ouroboros Consensus. 
 - [ ] Ouroboros Network is integrated into the Ouroboros Consensus.
-- [ ] Outroboros Consensus is integrated into the Cardano API.
+- [ ] Ouroboros Consensus is integrated into the Cardano API.
 - [ ] Cardano API is integrated into the Cardano CLI.
 - [ ] Cardano CLI is integrated into the Cardano Node.
 
diff --git a/.github/ISSUE_TEMPLATE/user-facing-feature.md b/.github/ISSUE_TEMPLATE/user-facing-feature.md
@@ -25,7 +25,7 @@ assignees: ''
 
 ## Definition of Done (DoD)
 
-- [ ] [Acceptance Criteria + User Stories & DoD](https://input-output.atlassian.net/wiki/spaces/QA/pages/3584229468/Acceptance+Criteria+DoD) created and singed-off (by PO, dev & test owners)
+- [ ] [Acceptance Criteria + User Stories & DoD](https://input-output.atlassian.net/wiki/spaces/QA/pages/3584229468/Acceptance+Criteria+DoD) created and signed-off (by PO, dev & test owners)
 - [ ] Builds successfully on CI
 - [ ] Code & Test review (as per Acceptance Criteria)
 - [ ] There is documentation and/or examples for the new functionality (usage/response)
@@ -54,6 +54,6 @@ assignees: ''
 
 ## Acceptance Criteria
 
-Acceptance Criteria & User Stories define here (or in a separate file (linked here) for a big feature)
+Acceptance Criteria & User Stories defined here (or in a separate file (linked here) for a big feature)
 
 Example - https://github.com/intersectmbo/cardano-node/issues/4453
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -12,7 +12,7 @@ to the issue.
   - property tests
   - roundtrip tests
   - integration tests
-  See [Runnings tests](https://github.com/input-output-hk/cardano-node-wiki/wiki/Running-tests) for more details
+  See [Running tests](https://github.com/input-output-hk/cardano-node-wiki/wiki/Running-tests) for more details
 - [ ] Any changes are noted in the `CHANGELOG.md` for affected package
 - [ ] The version bounds in `.cabal` files are updated
 - [ ] CI passes. See note on CI.  The following CI checks are required:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,7 +20,7 @@ give a way to enforce it).
 ## Testing
 
 `cardano-node` is essentially a container which implements several
-components such networking, consensus, and storage. These components
+components such as networking, consensus, and storage. These components
 have individual test coverage. The node goes through integration and
 release testing by Devops/QA while automated CLI tests are ongoing
 alongside development.
@@ -97,7 +97,7 @@ generation workload -- using the `workbench` environment:
     - `default` stands for a light-state, 6-node cluster, under
       transaction saturation workload, ~30min runtime.
     - `ci-test-hydra` is the profile run in the node CI -- very light,
-      just two nodes, Plutus transaction worklooad, =\< 3min runtime.
+      just two nodes, Plutus transaction workload, =\< 3min runtime.
     - `devops` is an unloaded profile (no transaction workload) with
       short slots -- `0.2` sec.
     - ...and many more -- which can be: - listed by name with
diff --git a/RELEASE.md b/RELEASE.md
@@ -43,7 +43,7 @@ This is the release process for node release hot fixes:
 
 # Rotating Release Engineer Role
 
-All sprints are aligned across the node and it's components. At the end of a sprint cycle the new rotating Release Engineer is decided on by the leadership team.
+All sprints are aligned across the node and its components. At the end of a sprint cycle the new rotating Release Engineer is decided on by the leadership team.
 This person's primary duties are integration of new releases of dependencies up the stack to the node. They serve this role until the release is finalized
 according to the above release process (ideally 1 sprint cycle).
 The Release Engineer works with the Dev Leads to decide which changes should be included in their component, including any in-flight PRs that haven't been merged yet.
diff --git a/bench/locli/CHANGELOG.md b/bench/locli/CHANGELOG.md
@@ -14,7 +14,7 @@
 
 * New CLI command `dump-tracefreqs` to write out per-host trace frequencies JSON files
 * Introduce `Reducer` type class for `locli-quick` based quick query evaluation
-* Sample `Reducer` instance implmentations: data types `TxsInMempool`, `Silence` and `ResourceMeasure`
+* Sample `Reducer` instance implementations: data types `TxsInMempool`, `Silence` and `ResourceMeasure`
 * Add plotting capabilities (experimental) via a heavily modded fork of package `easyplot-1.0` (module `EasyPlot.hs` and its license)
 
 ## 2.0 -- Dec 2024
diff --git a/cardano-node/ChangeLog.md b/cardano-node/ChangeLog.md
@@ -145,7 +145,7 @@
 
 - Added `PeerSharing` option in the configuration file which enables an
   experimental feature.  By default peer sharing is disabled. Please note that
-  until genesis & eclipse evasion are available this feauture can expose a node
+  until genesis & eclipse evasion are available this feature can expose a node
   to eclipse attacks.
 
 - The `TracePeerSelection` have new trace points which log peer sharing request
@@ -481,7 +481,7 @@ None
   which was allowing arbitrarily distant translation only in the last era. This
   bug has been fixed, but the ledger must preserve the previous behaviour in the
   existing era. (#2785)
-- Translate legacy cost mode parameter names in the JSON deserialiser. The
+- Translate legacy cost model parameter names in the JSON deserialiser. The
   deserialiser now does not care about the names, only about the ordering of the
   parameters. This is consistent with how cost model parameters are treated in
   update proposals. (#2792)
@@ -543,7 +543,7 @@ None
   by default in other deployments. (#3349)
 - Change the default verbosity of the startup tracer - normal verbosity now
   shows only maximal supported note-to-node and node-to-client versions
-  (previously it showed all supported verions). (#3434)
+  (previously it showed all supported versions). (#3434)
 - Enrich the ledger replay tracers to show significantly more information.
   (#3412)
 - Support for using `TxIn` as a key in JSON maps. (#3438)
@@ -677,7 +677,7 @@ None
 - Fix the configuration of the `chainSyncServerHeaderTracer`. This fixes a bug
   which caused logs to be unnecessarily verbose. (#3252)
 - Various documentation updates. (#3191, #3243, #3265, #3284)
-- Various infrastrucutre updates. (#3244, #3223, #3266, #3270, #3277, #3280,
+- Various infrastructure updates. (#3244, #3223, #3266, #3270, #3277, #3280,
   #3283 #3284, #3290, #3298, #3308)
 - Introduce the 'trace-dispatcher' library. This is built to replace the
   existing 'iohk-monitoring-framework'. (#3073)
@@ -714,7 +714,7 @@ None
 - Work around a bug on OS/X calling `accept` on IPv6 sockets. (#3368)
 - Continual gradual merge of p2p functionality. (#3369, #3370, #3371, #3372,
   #3373, #3374, #3377)
-- Miscallaneous documentation changes. (#3383, #3399)
+- Miscellaneous documentation changes. (#3383, #3399)
 - Fix a race condition in the thread tracking set. This could result in a node
   eventually refusing to accept new connections. (#3398)
 - Various internal refactorings. (#3079, #3416, #3432, #3437)
@@ -732,7 +732,7 @@ None
   and isolating it from the ledger. This is done in anticipation of introducing
   a new version of the consensus protocol in the Babbage release. (#2491, #2505,
   #2510, #2516, #2518)
-- Document the minumum value computation for Alonzo. (#2486)
+- Document the minimum value computation for Alonzo. (#2486)
 - Various changes to compactify the in-memory representation of the Cardano
   ledger state:
   - Unpack the TxId in a transaction input. (#2501)
@@ -804,7 +804,7 @@ None
 - Add additional capabilities to the tx generator:
   - Plutus. (#2853)
   - Fees and UTxO. (#2980)
-  - Miscallaneous bugfixes. (#3015)
+  - Miscellaneous bugfixes. (#3015)
 - Update the genesis hash mismatch error for Alonzo. (#3003)
 - Introduce the _trace-forward_ library, which is part of the replacement for
   the logging infrastructure. (#2960)
@@ -813,7 +813,7 @@ None
 
 - Allow the node to modify the maximum capacity of the mempool, in terms of
   various factors (size, execution units). (#3246, #3261, #3266)
-- Enable the Alzono era by default. (#3295)
+- Enable the Alonzo era by default. (#3295)
 - Internal testing improvements. (#3252, #3256)
 - Various internal improvements. (#3268, #3270, #3272, #3275, #3286)
 - Documentation updates. (#3269, #3273)
@@ -1024,7 +1024,7 @@ None
 - Update the iohk-monitoring framework to fix a file descriptor leak. (#2518)
 
 ### ledger changes
-- Fix an unevalutated thunk error in reward computation. (#2183)
+- Fix an unevaluated thunk error in reward computation. (#2183)
 - Additional properties added to the Mary/Allegra formal specification (#2178)
 - Updates to the Alonzo formal specification (#2189, #2194)
 - Work on implementing the upcoming Alonzo era. (#2176, #2185, #2190)
@@ -1055,7 +1055,7 @@ None
 ### consensus changes
 - Add some additional tracing infrastructure (#2874)
 - Add an automated test for forking from Allegra to Mary eras (#2915)
-- Continued work on the technical report of the consensus and storate layer
+- Continued work on the technical report of the consensus and storage layer
   (#2939, #2943)
 - Add the ability to query a node to determine whether it issued a block. This
   supports the "blocks lost due to switching" metric mentioned in the node
@@ -1264,7 +1264,7 @@ None
 ### network changes
 - Preparations for publishing io-sim as a public library (#2775)
 - Internal improvements to the "snockets" API (#2772, #2777)
-- Improved logging of the creation of the node's sockts (#2746)
+- Improved logging of the creation of the node's sockets (#2746)
 
 ## 1.23.0 -- November 2020
 
@@ -1282,7 +1282,7 @@ None
 
 - Fix a space leak in the stake pool performance tracking that caused writing
   ledger state snapshots in consensus to take too long (#1967)
-- Improved ledger state serialisation performance. This involving a change to
+- Improved ledger state serialisation performance. This involved a change to
   the serialisation format which will require the ledger state to be rebuilt
   upon node startup (#1968)
 - Further development for the Allegra era (#1951, #1965, #1984, #1989)
@@ -1744,7 +1744,7 @@ No changes in the node. There were changes in the cardano-api and cardano-cli.
 - Extend hard fork tests to include network partitions at interesting times
   around or during the hard fork (#2292, #2337, #2342)
 - Prefer blocks we created, irrespective of the VRF value (#1286, #2348)
-- Allow setting the intial Praos nonce (#2005, #2289)
+- Allow setting the initial Praos nonce (#2005, #2289)
 - Richer support for queries when using multiple protocol eras to allow some
   queries to be answered outside of the era to which they belong (#2349)
 - Optimisation in chain selection for forks (#1223, #2323)
@@ -1885,17 +1885,17 @@ No changes in the node. There were changes in the cardano-api and cardano-cli.
 
 - Support initial Shelley protocol parameters in the Shelley genesis (#906)
 - New `--shutdown-on-slot-synced` flag for benchmarking and CI tests (#776)
-- systemd socket activiation support (#856, #1022)
+- systemd socket activation support (#856, #1022)
 - systemd support on Linux is now optional (#911)
 - Minor improvement to `FetchDecision` tracing output (#863)
 - Improved suppression of frequent repeated log messages (#842)
 - Trace the node uptime (#892)
 - Trace the number of transactions processed and blocks forged (#937, #943)
 - Trace the current set of node peers for the live view (#1007)
-- Fix structured tracing of txs within adopted blocs for analysis tools (#993)
+- Fix structured tracing of txs within adopted blocks for analysis tools (#993)
 - Log the node's network magic number on startup (#921)
 - Adjust configuration to keep metrics out of the log files (#930)
-- Added OSX (Darwin) support for OS metics in the "live view" (#888)
+- Added OSX (Darwin) support for OS metrics in the "live view" (#888)
 - Various live view fixes (#964, #965, #974)
 
 ### consensus changes
@@ -2035,7 +2035,7 @@ No changes in the node. There were changes in the cardano-api and cardano-cli.
 - Performance improvement in validation from improved hash representation (#760)
 
 ### network changes
-- Improved Windows IO mangager exception handling (#1897)
+- Improved Windows IO manager exception handling (#1897)
 - Handle DNS server changes due to switching network connection (#1891)
 - Numerous small memory-use reductions in low level network code (#1902)
 - Label network threads for more useful performance profile output (#1900)
@@ -2344,7 +2344,7 @@ No changes in the node. There were changes in the cardano-api and cardano-cli.
 - Remove unused legacy and wallet configuration fields (code and config files)
 - Improve README files
 - Hide tracing options from default `--help` command
-- Fix flakeyness in logging setup & shutdown
+- Fix flakiness in logging setup & shutdown
 - Stop message counter messages from appearing in log files
 - Refactor CLI and config parser code.
 
@@ -2369,7 +2369,7 @@ No changes in the node. There were changes in the cardano-api and cardano-cli.
 - Remove dependency on scrypt
 - Add tests for isRedeemAddress, improve address encoding/decoding
 
-### #network changes
+### network changes
 - Added initial peer-to-peer governor with QC tests. Not yet used.
 
 ## 1.1.0 -- December 2019
diff --git a/cardano-submit-api/README.md b/cardano-submit-api/README.md
@@ -5,7 +5,7 @@ Setting this up for testing and for actual use on a real network.
 
 ### Pre-requisites
 
-You will need some a cardano network with payment address and keys.  This may be on `mainnet`, official `testnet`
+You will need a cardano network with payment address and keys.  This may be on `mainnet`, official `testnet`
 or a testnet that you've set up yourself.  We will assume these files are in a directory called `playground`:
 
 * `user-1-payment.addr` - User 1 payment address.  This address must have sufficient funds.
@@ -60,7 +60,7 @@ playground $ CARDANO_NODE_SOCKET_PATH=node.socket cardano-cli query utxo --addre
 8a3d63d4d95f669ef62570f2936ad50d2cfad399e04808ca21474e70b11987ee     0        97640000 lovelace
 ```
 
-Save that date into environment variables for future use.  For example:
+Save that data into environment variables for future use.  For example:
 
 ```bash
 playground $ txhash=8a3d63d4d95f669ef62570f2936ad50d2cfad399e04808ca21474e70b11987ee
diff --git a/cardano-testnet/CHANGELOG.md b/cardano-testnet/CHANGELOG.md
@@ -29,4 +29,4 @@
 
 ## 8.1.0
 
-- [Paramaterize default node configuration on era](https://github.com/intersectmbo/cardano-node/pull/5211)
+- [Parameterize default node configuration on era](https://github.com/intersectmbo/cardano-node/pull/5211)
diff --git a/cardano-tracer/CHANGELOG.md b/cardano-tracer/CHANGELOG.md
@@ -57,7 +57,7 @@
 ## 0.3 (September 26, 2024)
 
 * Fix the creation of empty logs.
-* Abondon `snap` webserver in favour of `wai`/`warp` for Prometheus and EKG Monitoring.
+* Abandon `snap` webserver in favour of `wai`/`warp` for Prometheus and EKG Monitoring.
 * Add dynamic routing to EKG stores of all connected nodes.
 * Derive URL compliant routes from connected node names (instead of plain node names).
 * Remove the requirement of two distinct ports for the EKG backend (changing `hasEKG` config type).
diff --git a/cardano-tracer/demo/multi/README.md b/cardano-tracer/demo/multi/README.md
@@ -4,7 +4,7 @@ Run `./run.sh PASS FMODE`, where `FMODE` is forwarders' mode: `Responder` or `In
 
 As a result, 3 `demo-forwarder`s and one `cardano-tracer` will be launched. It imitates the real-world situation when `N` nodes work with one `cardano-tracer`.
 
-Please note that if you run the script with `Responder` mode, `demo-forwarder`s work as a servers, and `cardano-tracer` works as a client:
+Please note that if you run the script with `Responder` mode, `demo-forwarder`s work as servers, and `cardano-tracer` works as a client:
 
 ```
 +------------------+
diff --git a/cardano-tracer/docs/cardano-rtview.md b/cardano-tracer/docs/cardano-rtview.md
@@ -31,7 +31,7 @@ guarantee it remains buildable and usable in its current state.
 
 For a long time, Stake Pool Operators used third-party tools for monitoring their Cardano nodes, such as [Grafana](https://grafana.com/grafana/dashboards/12469)-based installations. These third-party solutions work, but they have two main problems:
 
-1. Complex setup, especially for non-technical person.
+1. Complex setup, especially for a non-technical person.
 2. Limited kinds of displayed information. For example, metrics can be shown, but error messages cannot.
 
 RTView solves both of them:
@@ -170,7 +170,7 @@ You can specify how frequently you want to receive notifications for a specific
 
 If you selected `Immediately`, the new email with the associated event(s) will be sent right away. It can be used for critical events: most likely, you want to know about such events as soon as possible.
 
-If you selected `Every 12 hours`, the new email with associated event(s) will be sent only two times a day. I can be used for non-critical events, like `Warnings`.
+If you selected `Every 12 hours`, the new email with associated event(s) will be sent only two times a day. It can be used for non-critical events, like `Warnings`.
 
 # UI
 
@@ -182,7 +182,7 @@ When you open the web page for the first time, you'll see a warning from your br
 
 When the node connects to `cardano-tracer` and RTView's page displays the first data from it, you may see that some other data is missing: there is `—` instead of particular value. There are following possible reasons for it:
 
-1. The node didn't provide corresponding metrics _yet_, because some information (for example, sync percent) can be displayed only after few minutes after node's start.
+1. The node didn't provide corresponding metrics _yet_, because some information (for example, sync percent) can be displayed only after a few minutes after node's start.
 2. The node _cannot_ provide corresponding metrics. For example, forging-related metrics make sense only for producer node, not for relay node.
 3. The node doesn't provide corresponding metrics because of node's configuration. For example, it can specify severity filter for particular metric, so it just filtered out.
 4. The node is incompatible with `cardano-tracer` (they were built from different branches of `cardano-node` repository). For example, particular metric may be renamed in the node, but `cardano-tracer` is still using outdated name.
@@ -192,4 +192,4 @@ When the node connects to `cardano-tracer` and RTView's page displays the first
 If the node is configured as a _producer_ - i.e. it can forge the new blocks - you will see a hammer icon near the node's name. So, there are two possible reasons if you don't see this hammer icon:
 
 1. The node is configured as a relay, not as a producer.
-2. The node is not reported about its "producer status" yet.
+2. The node has not reported its "producer status" yet.
diff --git a/cardano-tracer/docs/cardano-tracer.md b/cardano-tracer/docs/cardano-tracer.md
@@ -250,7 +250,7 @@ There is another way to connect `cardano-tracer` to your nodes: the `cardano-tra
 
 As you see, the tag in `network` field is `ConnectTo` now, which means that `cardano-tracer` works as a client: it _establishes_ network connections with your local nodes via the local sockets `/tmp/cardano-node-*.sock`. In this case each socket is used by a particular node.
 
-`AcceptTo` and `ConnectTo` are mirrored by the reciprocal CLI option on the node `--tracer-socket-path-connect` / `--tracer-socket-path-accept`. If you choose one on the node, you choose the opposite on the tracer. This only makes a difference to which entity initiates the handshake; after the handshake the configuration is identical
+`AcceptAt` and `ConnectTo` are mirrored by the reciprocal CLI option on the node `--tracer-socket-path-connect` / `--tracer-socket-path-accept`. If you choose one on the node, you choose the opposite on the tracer. This only makes a difference to which entity initiates the handshake; after the handshake the configuration is identical
 
 Please use `ConnectTo`-based scenario only if you really need it. Otherwise, it is **highly recommended** to use `AcceptAt`-based scenario. The reason is easier maintenance. Suppose you have 3 working nodes, and they are connected to the same `cardano-tracer`. And then you want to connect 4-th node to it. If `cardano-tracer` is configured using `AcceptAt`, you shouldn't change its configuration - you just connect your 4-th node to it. But if `cardano-tracer` is configured using `ConnectTo`, you should add path to 4-th socket in its configuration file and then restart `cardano-tracer` process.
 
@@ -367,7 +367,7 @@ The fields `rpMaxAgeMinutes`, `rpMaxAgeHours` specify the lifetime of the log fi
 
 ## Prometheus
 
-At top-level route `/` Promtheus gives a list of connected nodes.
+At top-level route `/` Prometheus gives a list of connected nodes.
 
 The responses are either human-readable names (HTML) with clickable
 links, or JSON mapping from connected node names to relative URLs,
diff --git a/trace-dispatcher/CHANGELOG.md b/trace-dispatcher/CHANGELOG.md
diff --git a/trace-dispatcher/doc/trace-dispatcher.md b/trace-dispatcher/doc/trace-dispatcher.md
diff --git a/trace-resources/CHANGELOG.md b/trace-resources/CHANGELOG.md

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,4 @@`
`29`	`29`
`30`	`30`	`## 8.1.0`
`31`	`31`
`32`		`-- [Paramaterize default node configuration on era](https://github.com/intersectmbo/cardano-node/pull/5211)`
	`32`	`+- [Parameterize default node configuration on era](https://github.com/intersectmbo/cardano-node/pull/5211)`