Skip to content

Commit 02b4353

Browse files
committed
Point ADR doc-URL refs at TagSpec.edi_name
1 parent 9800545 commit 02b4353

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/dev/adrs/accepted/edstar-project-persistence.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1231,13 +1231,13 @@ implementation should add a small documentation-url resolver that:
12311231
a page or anchor cannot be derived from the Edi name.
12321232

12331233
The shared resolver should be the only code that knows the absolute site
1234-
base and version folder. `CifHandler.project_name` (introduced by
1235-
Migration Sketch step 1) is the source value for ordinary descriptors;
1236-
descriptor classes expose `param.url` by asking the resolver to build
1237-
the URL from that project name. This keeps old installed versions linked
1238-
to the documentation version they were tested against, while future docs
1239-
reorganizations require changing one resolver or adding redirects rather
1240-
than editing every parameter declaration.
1234+
base and version folder. `TagSpec.edi_name` (the canonical Edi tag) is
1235+
the source value for ordinary descriptors; descriptor classes expose
1236+
`param.url` by asking the resolver to build the URL from that project
1237+
name. This keeps old installed versions linked to the documentation
1238+
version they were tested against, while future docs reorganizations
1239+
require changing one resolver or adding redirects rather than editing
1240+
every parameter declaration.
12411241

12421242
Parameter-reference detail pages must publish stable explicit anchors
12431243
derived by the same helper used by the resolver. Do not rely on MkDocs'
@@ -1293,7 +1293,7 @@ new extension is required.
12931293
category, preserving current and official tags as read aliases.
12941294
6. Add the shared versioned documentation-url resolver and descriptor
12951295
`url` property, deriving ordinary parameter URLs from
1296-
`CifHandler.project_name`.
1296+
`TagSpec.edi_name`.
12971297
7. Rework the user-guide parameter reference per §Documentation:
12981298
Parameter-Reference Pages — three-tab tables ("How to access in the
12991299
code", "Keys in Edi", "Keys in CIF"), Edi-named and

0 commit comments

Comments
 (0)