Merged
Conversation
carbolymer
changed the title
There was a problem hiding this comment.
Pull request overview
This PR improves navigability across the Architecture Decision Records (ADRs) by adding reciprocal “Related ADRs” sections, helping readers discover connected decisions and conventions.
Changes:
- Add “Related ADRs” sections to multiple ADR documents to cross-reference relevant decisions.
- Update ADR-011 to reference ADR-008 using a standard Markdown link.
- Add cross-links between ADRs that define CLI conventions, era policies, and conversion/typeclass conventions.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/ADR-015-Cardano-API-WASM-library-for-browser.md | Adds a “Related ADRs” section referencing era scope and conversion/typeclass analogies. |
| docs/ADR-014-Total-conversion-functions-conventions.md | Adds “Related ADRs” linking module/export conventions and APIs that should use Inject/Convert. |
| docs/ADR-013-Metavars-must-follow-screaming-snake-case.md | Adds “Related ADRs” tying metavar naming to optparse fork and CLI flag construction ADR. |
| docs/ADR-012-standardise-CLI-multiple-choice-flags-construction.md | Adds “Related ADRs” linking to optparse fork ADR and metavar naming conventions. |
| docs/ADR-011-Better-call-stacks-of-io-exceptions.md | Replaces an informal reference with a proper Markdown link to ADR-008. |
| docs/ADR-010-cardano-api-script-witness-api.md | Adds “Related ADRs” linking era availability and Inject/Convert conversion conventions. |
| docs/ADR-009-cardano-api-exports-convention.md | Adds “Related ADRs” connecting generator structure, era exposure, and instance placement conventions. |
| docs/ADR-007-CLI-Output-Presentation.md | Adds “Related ADRs” linking CLI output conventions to related CLI-focused ADRs. |
| docs/ADR-006-Using-optparse-applicative-main-repository.md | Adds “Related ADRs” pointing to ADRs that rely on the fork and its help output. |
| docs/ADR-005-cardano-testnet-node-configuration-file.md | Adds “Related ADRs” connecting new CLI command behavior to output conventions. |
| docs/ADR-004-Support-only-for-mainnet-and-upcoming-eras.md | Adds “Related ADRs” linking default era policy, exports structure, witness API, and WASM API era exposure. |
| docs/ADR-003-Dependencies-version-constraints-in-cabal-file.md | Adds “Related ADRs” referencing the optparse fork as an example of fork constraints. |
| docs/ADR-001-Default-eras-for-CLI-commands.md | Adds “Related ADRs” linking to era exposure policy and CLI flag construction conventions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
carbolymer
force-pushed
the
mgalazyn/cross-link-adrs
branch
from
1fecb23 to
2712e65
Compare
carbolymer
force-pushed
the
mgalazyn/cross-link-adrs
branch
from
0f76f54 to
5ab20ff
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 25 out of 25 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/ADR-012-standardise-CLI-multiple-choice-flags-construction.md
Outdated
Show resolved
Hide resolved
carbolymer
force-pushed
the
mgalazyn/cross-link-adrs
branch
from
06615a6 to
f49f174
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 25 out of 25 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Jimbo4350
approved these changes
Mar 12, 2026
carbolymer
force-pushed
the
mgalazyn/cross-link-adrs
branch
from
924ec69 to
b4e7ed4
Compare
carbolymer
force-pushed
the
mgalazyn/cross-link-adrs
branch
from
b4e7ed4 to
02b4e4b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.