Skip to content

Commit e5a9c73

Browse files
authored
Update links for repos that have moved to the swiftlang organization so far (#977)
* Update links to hosted documentation with new GH organization name * Update links to moved repositories * Update links to moved Swift-DocC issues, files, and contribution info * Update source base argument for DocC's reference documentation
1 parent 2c7c16d commit e5a9c73

21 files changed

+45
-45
lines changed

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ from the community.
3636

3737
Before contributing code or documentation to Swift-DocC,
3838
we encourage you to first open a
39-
[GitHub issue](https://github.com/apple/swift-docc/issues/new/choose)
39+
[GitHub issue](https://github.com/swiftlang/swift-docc/issues/new/choose)
4040
for a bug report or feature request.
4141
This will allow us to provide feedback on the proposed change.
4242
However, this is not a requirement. If your contribution is small in scope,
@@ -256,7 +256,7 @@ mkdir .build/swift-docc-symbol-graphs \
256256
#### 2. Set the path to your renderer
257257
258258
The best place to get started with Swift-DocC-Render is with the
259-
instructions in the [project's README](https://github.com/apple/swift-docc-render).
259+
instructions in the [project's README](https://github.com/swiftlang/swift-docc-render).
260260

261261
If you have Xcode 13 or later installed, you can use the version of Swift-DocC-Render
262262
that comes included in Xcode with:
@@ -266,11 +266,11 @@ export DOCC_HTML_DIR="$(dirname $(xcrun --find docc))/../share/docc/render"
266266
```
267267

268268
Alternatively, you can clone the
269-
[Swift-DocC-Render-Artifact repository](https://github.com/apple/swift-docc-render-artifact)
269+
[Swift-DocC-Render-Artifact repository](https://github.com/swiftlang/swift-docc-render-artifact)
270270
and use a recent pre-built copy of the renderer:
271271

272272
```sh
273-
git clone https://github.com/apple/swift-docc-render-artifact.git
273+
git clone https://github.com/swiftlang/swift-docc-render-artifact.git
274274
```
275275

276276
Then point the `DOCC_HTML_DIR` environment variable
@@ -453,7 +453,7 @@ If you do not have commit access, please ask one of the code owners to trigger t
453453
## Your First Contribution
454454
455455
Unsure of where to begin contributing to Swift-DocC? You can start by looking at
456-
the issues on the [good first issue](https://github.com/apple/swift-docc/contribute)
456+
the issues on the [good first issue](https://github.com/swiftlang/swift-docc/contribute)
457457
page.
458458
459459
Once you've found an issue to work on,
@@ -489,7 +489,7 @@ More concretely, Swift-DocC understands the following kinds of inputs:
489489
Swift-DocC outputs a machine-readable archive of the compiled documentation.
490490
This archive contains _render JSON_ files, which fully describe the contents
491491
of a documentation page and can be processed by a renderer such as
492-
[Swift-DocC-Render](https://github.com/apple/swift-docc-render).
492+
[Swift-DocC-Render](https://github.com/swiftlang/swift-docc-render).
493493
494494
For more in-depth technical information about Swift-DocC, please refer to the
495495
project's technical documentation:
@@ -502,15 +502,15 @@ project's technical documentation:
502502
- As of Swift 5.5, the [Swift Compiler](https://github.com/apple/swift) is able to
503503
emit _Symbol Graph_ files as part of the compilation process.
504504

505-
- [SymbolKit](https://github.com/apple/swift-docc-symbolkit) is a Swift package containing
505+
- [SymbolKit](https://github.com/swiftlang/swift-docc-symbolkit) is a Swift package containing
506506
the specification and reference model for the _Symbol Graph_ File Format.
507507

508508
- [Swift Markdown](https://github.com/apple/swift-markdown) is a
509509
Swift package for parsing, building, editing, and analyzing
510510
Markdown documents. It includes support for the Block Directive elements
511511
that Swift-DocC's tutorial files rely on.
512512
513-
- [Swift-DocC-Render](https://github.com/apple/swift-docc-render)
513+
- [Swift-DocC-Render](https://github.com/swiftlang/swift-docc-render)
514514
is a web application that understands and renders
515515
Swift-DocC's _render JSON_ format.
516516

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ There are multiple ways you can make use of DocC depending on your use case:
3838
**1. For documenting packages via SwiftPM:**
3939

4040
If you want to generate documentation for your Swift package we recommend using the Swift-DocC Plugin. Please
41-
refer to the Plugin's [documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/) to get started with
42-
[building](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-a-specific-target), [previewing](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/previewing-documentation),
43-
and publishing your documentation to your [website](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online) or [GitHub Pages](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages).
41+
refer to the Plugin's [documentation](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/) to get started with
42+
[building](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-a-specific-target), [previewing](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/previewing-documentation),
43+
and publishing your documentation to your [website](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online) or [GitHub Pages](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages).
4444

4545
**2. For standalone documentation:**
4646

@@ -81,9 +81,9 @@ active development and source stability is not guaranteed.
8181
### Submitting a Bug Report
8282

8383
Swift-DocC tracks all bug reports with
84-
[GitHub Issues](https://github.com/apple/swift-docc/issues).
84+
[GitHub Issues](https://github.com/swiftlang/swift-docc/issues).
8585
When you submit a bug report we ask that you follow the
86-
[provided template](https://github.com/apple/swift-docc/issues/new?assignees=&labels=bug&template=BUG_REPORT.yml)
86+
[provided template](https://github.com/swiftlang/swift-docc/issues/new?assignees=&labels=bug&template=BUG_REPORT.yml)
8787
and provide as many details as possible.
8888

8989
> **Note:** You can use the [`environment`](bin/environment) script
@@ -101,7 +101,7 @@ it will help us track down the bug faster..
101101
### Submitting a Feature Request
102102
103103
For feature requests, please feel free to file a
104-
[GitHub issue](https://github.com/apple/swift-docc/issues/new?assignees=&labels=enhancement&template=FEATURE_REQUEST.yml)
104+
[GitHub issue](https://github.com/swiftlang/swift-docc/issues/new?assignees=&labels=enhancement&template=FEATURE_REQUEST.yml)
105105
or start a discussion on the [Swift Forums](https://forums.swift.org/c/development/swift-docc).
106106
107107
Don't hesitate to submit a feature request if you see a way

Sources/SwiftDocC/Indexing/Navigator/RenderNode+NavigatorIndex.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ extension NavigatorIndexableRenderNodeRepresentation {
131131
func navigatorTitle() -> String? {
132132
let tokens: [DeclarationRenderSection.Token]?
133133

134-
// FIXME: Use `metadata.navigatorTitle` for all Swift symbols (github.com/apple/swift-docc/issues/176).
134+
// FIXME: Use `metadata.navigatorTitle` for all Swift symbols (github.com/swiftlang/swift-docc/issues/176).
135135
if identifier.sourceLanguage == .swift || (metadata.navigatorTitle ?? []).isEmpty {
136136
let pageType = navigatorPageType()
137137
guard !typesThatShouldNotUseNavigatorTitle.contains(pageType) else {

Sources/SwiftDocC/Infrastructure/DocumentationContext.swift

+5-5
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
414414
for reference in rootModules {
415415
if let node = try? entity(with: reference) {
416416
// A module node should always have a symbol.
417-
// Remove the fallback value and force unwrap `node.symbol` on the main branch: https://github.com/apple/swift-docc/issues/249
417+
// Remove the fallback value and force unwrap `node.symbol` on the main branch: https://github.com/swiftlang/swift-docc/issues/249
418418
moduleNameCache[reference] = (node.name.plainText, node.symbol?.names.title ?? reference.lastPathComponent)
419419
}
420420
}
@@ -1120,7 +1120,7 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
11201120
// FIXME: Update with new SymbolKit API once available.
11211121
// This is a very inefficient way to gather the source languages
11221122
// represented in a symbol graph. Adding a dedicated SymbolKit API is tracked
1123-
// with github.com/apple/swift-docc-symbolkit/issues/32 and rdar://85982095.
1123+
// with github.com/swiftlang/swift-docc-symbolkit/issues/32 and rdar://85982095.
11241124
let symbolGraphLanguages = Set(
11251125
unifiedSymbolGraph.symbols.flatMap(\.value.sourceLanguages)
11261126
)
@@ -1247,7 +1247,7 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
12471247
continue
12481248
}
12491249

1250-
// FIXME: Resolve the link relative to the module https://github.com/apple/swift-docc/issues/516
1250+
// FIXME: Resolve the link relative to the module https://github.com/swiftlang/swift-docc/issues/516
12511251
let reference = TopicReference.unresolved(.init(topicURL: url))
12521252
switch resolve(reference, in: bundle.rootReference, fromSymbolLink: true) {
12531253
case .success(let resolved):
@@ -1264,7 +1264,7 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
12641264
// The ConvertService relies on old implementation detail where documentation extension files were always considered "resolved" even when they didn't match a symbol.
12651265
//
12661266
// Don't rely on this behavior for new functionality. The behavior will be removed once we have a new solution to meets the needs of the ConvertService. (rdar://108563483)
1267-
// https://github.com/apple/swift-docc/issues/567
1267+
// https://github.com/swiftlang/swift-docc/issues/567
12681268
//
12691269
// The process that interacts with the convert service is responsible for:
12701270
// - Distinguishing between documentation extension files that match symbols and documentation extension files that don't match symbols.
@@ -1950,7 +1950,7 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
19501950
path: path,
19511951
sourceLanguages: availableSourceLanguages
19521952
// FIXME: Pages in article-only catalogs should not be inferred as "Swift" as a fallback
1953-
// (github.com/apple/swift-docc/issues/240).
1953+
// (github.com/swiftlang/swift-docc/issues/240).
19541954
?? [.swift]
19551955
)
19561956

Sources/SwiftDocC/Infrastructure/External Data/OutOfProcessReferenceResolver.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
149149
var renderReference = TopicRenderReference(
150150
identifier: .init(reference),
151151
title: resolvedInformation.title,
152-
// The resolved information only stores the plain text abstract https://github.com/apple/swift-docc/issues/802
152+
// The resolved information only stores the plain text abstract https://github.com/swiftlang/swift-docc/issues/802
153153
abstract: [.text(resolvedInformation.abstract)],
154154
url: resolvedInformation.url.path,
155155
kind: kind,
@@ -547,7 +547,7 @@ extension OutOfProcessReferenceResolver {
547547
public struct ResolvedInformation: Codable {
548548
// This type is duplicating the information from LinkDestinationSummary with some minor differences.
549549
// Changes generally need to be made in both places. It would be good to replace this with LinkDestinationSummary.
550-
// FIXME: https://github.com/apple/swift-docc/issues/802
550+
// FIXME: https://github.com/swiftlang/swift-docc/issues/802
551551

552552
/// Information about the resolved kind.
553553
public let kind: DocumentationNode.Kind

Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ struct PathHierarchy {
132132

133133
let node = Node(symbol: symbol, name: symbol.pathComponents.last!)
134134
// Disfavor synthesized symbols when they collide with other symbol with the same path.
135-
// FIXME: Get information about synthesized symbols from SymbolKit https://github.com/apple/swift-docc-symbolkit/issues/58
135+
// FIXME: Get information about synthesized symbols from SymbolKit https://github.com/swiftlang/swift-docc-symbolkit/issues/58
136136
if symbol.identifier.precise.contains("::SYNTHESIZED::") {
137137
node.specialBehaviors = [.disfavorInLinkCollision, .excludeFromAutomaticCuration]
138138
}

Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolReference.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ extension UnifiedSymbolGraph.Symbol {
169169
var sourceLanguages: Set<SourceLanguage> {
170170
// FIXME: Replace with new SymbolKit API once available.
171171
// Adding a dedicated SymbolKit API for this purpose is tracked
172-
// with github.com/apple/swift-docc-symbolkit/issues/32 and rdar://85982095.
172+
// with github.com/swiftlang/swift-docc-symbolkit/issues/32 and rdar://85982095.
173173
return Set(
174174
pathComponents.keys.map { selector in
175175
SourceLanguage(knownLanguageIdentifier: selector.interfaceLanguage)

Sources/SwiftDocC/Model/Rendering/DocumentationContentRenderer.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public class DocumentationContentRenderer {
107107
/// Returns the given amount of minutes as a string, for example: "1hr 10min".
108108
func formatEstimatedDuration(minutes: Int) -> String? {
109109
// TODO: Use DateComponentsFormatter once it's available on Linux (rdar://59787899) and
110-
// when Swift-DocC supports generating localized documentation (github.com/apple/swift-docc/issues/218), since
110+
// when Swift-DocC supports generating localized documentation (github.com/swiftlang/swift-docc/issues/218), since
111111
// DateComponentsFormatter formats content based on the user's locale.
112112
// let dateFormatter = DateComponentsFormatter()
113113
// if #available(OSX 10.12, *) {

Sources/SwiftDocC/Model/Rendering/RenderContentCompiler.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ struct RenderContentCompiler: MarkupVisitor {
220220
}
221221

222222
// FIXME: Links from this build already exist in the reference index and don't need to be resolved again.
223-
// https://github.com/apple/swift-docc/issues/581
223+
// https://github.com/swiftlang/swift-docc/issues/581
224224

225225
guard let validatedURL = ValidatedURL(parsingAuthoredLink: destination) else {
226226
return nil

Sources/SwiftDocC/Model/Rendering/RenderNodeTranslator.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ public struct RenderNodeTranslator: SemanticVisitor {
627627

628628
// Emit variants only if we're not compiling an article-only catalog to prevent renderers from
629629
// advertising the page as "Swift", which is the language DocC assigns to pages in article only pages.
630-
// (github.com/apple/swift-docc/issues/240).
630+
// (github.com/swiftlang/swift-docc/issues/240).
631631
if let topLevelModule = context.soleRootModuleReference,
632632
try! context.entity(with: topLevelModule).kind.isSymbol
633633
{

Sources/SwiftDocC/Model/SourceLanguage.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public struct SourceLanguage: Hashable, Codable, Comparable {
3838
switch id {
3939
case "swift": self = .swift
4040
case "occ", "objc", "objective-c", "c": self = .objectiveC
41-
// FIXME: DocC should display C++ and Objective-C++ as their own languages (https://github.com/apple/swift-docc/issues/767)
41+
// FIXME: DocC should display C++ and Objective-C++ as their own languages (https://github.com/swiftlang/swift-docc/issues/767)
4242
case "occ++", "objc++", "objective-c++", "c++": self = .objectiveC
4343
case "javascript": self = .javaScript
4444
case "data": self = .data
@@ -113,8 +113,8 @@ public struct SourceLanguage: Hashable, Codable, Comparable {
113113
idAliases: [
114114
"objective-c",
115115
"objc",
116-
"c", // FIXME: DocC should display C as its own language (github.com/apple/swift-docc/issues/169).
117-
"c++", // FIXME: DocC should display C++ and Objective-C++ as their own languages (https://github.com/apple/swift-docc/issues/767)
116+
"c", // FIXME: DocC should display C as its own language (github.com/swiftlang/swift-docc/issues/169).
117+
"c++", // FIXME: DocC should display C++ and Objective-C++ as their own languages (https://github.com/swiftlang/swift-docc/issues/767)
118118
"objective-c++",
119119
"objc++",
120120
"occ++",

Sources/SwiftDocC/Semantics/Metadata/Availability.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ extension Metadata {
7575
}
7676
}
7777
if rawValue == "*" {
78-
// Reserve the `*` platform for when we have decided on how `*` availability should be displayed (https://github.com/apple/swift-docc/issues/969)
78+
// Reserve the `*` platform for when we have decided on how `*` availability should be displayed (https://github.com/swiftlang/swift-docc/issues/969)
7979
return nil
8080
} else {
8181
self = .other(rawValue)

Sources/SwiftDocC/Semantics/ReferenceResolver.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func unresolvedReferenceProblem(source: URL?, range: SourceRange?, severity: Dia
2525
} else {
2626
// FIXME: This assumes that the link uses the `<doc:my/reference>` syntax.
2727
// Links that use the [link text](doc:my/reference) syntax will have incorrect suggestion replacements.
28-
// https://github.com/apple/swift-docc/issues/470
28+
// https://github.com/swiftlang/swift-docc/issues/470
2929

3030
// Inset the range by 5 at the start and by 1 at the end to skip "<doc:" at the start and ">" at the end.
3131
return SourceLocation(line: range.lowerBound.line, column: range.lowerBound.column+5, source: range.lowerBound.source) ..< SourceLocation(line: range.upperBound.line, column: range.upperBound.column-1, source: range.upperBound.source)

Sources/SwiftDocC/Semantics/Symbol/PlatformName.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public struct PlatformName: Codable, Hashable, Equatable {
114114
init?(metadataPlatform platform: Metadata.Availability.Platform) {
115115
// Note: This is still an optional initializer to prevent source breakage when
116116
// `Availability.Platform` re-introduces the `.any` case
117-
// cf. https://github.com/apple/swift-docc/issues/441
117+
// cf. https://github.com/swiftlang/swift-docc/issues/441
118118
if let knowDomain = Self.platformNamesIndex[platform.rawValue.lowercased()] {
119119
self = knowDomain
120120
} else {

Sources/docc/DocCDocumentation.docc/customizing-the-appearance-of-your-documentation-pages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Most notably:
250250
- ``PageImage`` allows you to set a header image of a page.
251251
- ``PageColor`` allows you to set an accent color of a page.
252252

253-
[1]: https://github.com/apple/swift-docc/blob/main/Sources/SwiftDocC/SwiftDocC.docc/Resources/ThemeSettings.spec.json
253+
[1]: https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/SwiftDocC.docc/Resources/ThemeSettings.spec.json
254254
[2]: https://drafts.csswg.org/css-variables/
255255
[3]: https://mportiz08.github.io/swift-docc/documentation/docc
256256
[4]: https://mportiz08.github.io/swift-docc/theme-settings.json

Sources/docc/DocCDocumentation.docc/distributing-documentation-to-other-developers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Distributing your documentation involves the following steps:
2525
### Generate a Publishable Archive of Your Documentation
2626

2727
To create a documentation archive for a Swift package, use the [SwiftPM DocC
28-
Plugin](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
28+
Plugin](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
2929
or use Xcode's _Build Documentation_ command.
3030

3131
Alternatively, use the `docc` command-line tool directly, for example:
@@ -143,7 +143,7 @@ You can also configure the base path path via the `--hosting-base-path` option
143143
when [building documentation using the SwiftPM DocC Plugin][plugin-docs] or via
144144
the `DOCC_HOSTING_BASE_PATH` build setting when building documentation in Xcode.
145145

146-
[plugin-docs]: https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online/
146+
[plugin-docs]: https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online/
147147

148148
#### Host a Documentation Archive Using Custom Routing
149149

0 commit comments

Comments
 (0)