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.
| - uses: actions/checkout@v4 | ||
| - uses: tcort/github-action-markdown-link-check@v1 | ||
| with: | ||
| use-quiet-mode: yes | ||
| config-file: '.github/mlc_config.json' |
There was a problem hiding this comment.
In this workflow YAML, the list items under steps: are not indented relative to the steps key. As written, this parses as steps: null and the - uses: entries become invalid at that level, causing the workflow to fail to load. Indent the - uses: lines (and their nested with:) under steps: (see .github/workflows/wiki-sync.yaml for the repo’s indentation pattern).
| - uses: actions/checkout@v4 | |
| - uses: tcort/github-action-markdown-link-check@v1 | |
| with: | |
| use-quiet-mode: yes | |
| config-file: '.github/mlc_config.json' | |
| - uses: actions/checkout@v4 | |
| - uses: tcort/github-action-markdown-link-check@v1 | |
| with: | |
| use-quiet-mode: yes | |
| config-file: '.github/mlc_config.json' |
| both an IPv4 and IPv6 host address. | ||
|
|
||
| Please see [Understanding configuration files](../getting-started/understanding-config-files.md) to learn about P2P topology. | ||
| Please see [Understanding configuration files](../reference/configuring-a-node-using-yaml.md) to learn about P2P topology. |
There was a problem hiding this comment.
The link text still says “Understanding configuration files”, but it now points to configuring-a-node-using-yaml.md whose title/content is “Configuring a node”. Updating the link text to match the destination would avoid confusing readers (and makes it easier to search for the referenced page).
| Please see [Understanding configuration files](../reference/configuring-a-node-using-yaml.md) to learn about P2P topology. | |
| Please see [Configuring a node](../reference/configuring-a-node-using-yaml.md) to learn about P2P topology. |
| } | ||
| ``` | ||
| Note: For details about topology files please refer to [Understanding configuration files](../getting-started/understanding-config-files.md). | ||
| Note: For details about topology files please refer to [Understanding configuration files](configuring-a-node-using-yaml.md). |
There was a problem hiding this comment.
The link text says “Understanding configuration files”, but the target is configuring-a-node-using-yaml.md (titled “Configuring a node”). Consider adjusting the link text to reflect the destination page to avoid misleading readers.
| Note: For details about topology files please refer to [Understanding configuration files](configuring-a-node-using-yaml.md). | |
| Note: For details about topology files please refer to [Configuring a node](configuring-a-node-using-yaml.md). |
No description provided.