cross-package links in the percent encoding article

[tayloraswift]

hi Karl,

swift-url has been listed on swiftinit; on swiftinit these cross-package links will just work :)

[karwa]

Awesome! Is this syntax compatible with DocC?

I still need to fix the documentation workflow on this repo. I think it broke due to GitHub updating the version of Node installed on their runners.

[tayloraswift]

these links won't resolve successfully on DocC, as DocC is a single-module documentation engine.

[karwa]

It seems that there has been recent work on supporting cross-module links in DocC: apple/swift-docc#710

Of course I'd want to use something that is DocC-compatible, and it would be unfortunate to break swiftinit when that happens.

[tayloraswift]

as far as i understand from David’s proposal, the scope of that effort is supporting cross-target references between modules within the same package. the references in this article are references to standard library symbols, and i am not aware of any plans to support that from the DocC side yet.

for what it’s worth, swiftinit is backwards-compatible with DocC symbol links, so all of those will still work. (and you can freely mix syntaces within the same article.) you just won’t be able to use unidoc features like multi-component symbol links or cross-package references.