Skip to content

Commit 8f1a9d2

Browse files
authored
Rename non-existent 5.11 release to 6.0 in the documentation (#936)
* Update mentions of non-existent 5.11 release to 6.0 * Generate a new directive symbol graph from the latest markup * Update an additional mention of the non-existent 5.11 release.
1 parent d304317 commit 8f1a9d2

File tree

3 files changed

+110
-23
lines changed

3 files changed

+110
-23
lines changed

Sources/SwiftDocC/Semantics/Redirect.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import Markdown
2121
/// @Redirected(from: "another/old/path/to/this/page")
2222
/// ```
2323
///
24-
/// > Note: Starting with version 5.11, the `Redirected` directive is supported both top-level and as a member of a ``Metadata`` directive. In
24+
/// > Note: Starting with version 6.0, the `Redirected` directive is supported both top-level and as a member of a ``Metadata`` directive. In
2525
/// earlier versions, the `Redirected` directive is only supported as a top-level directive.
2626
///
2727
/// ### Setting up Redirects

Sources/docc/DocCDocumentation.docc/DocC.symbols.json

Lines changed: 106 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2001,13 +2001,13 @@
20012001
"text" : ""
20022002
},
20032003
{
2004-
"text" : "When the ``style`` property is ``Style\/conceptual``, the symbol's name is rendered as \"conceptual\"same as article names or tutorial nameswhere applicable. The default style is ``Style\/conceptual``."
2004+
"text" : "When the ``style`` property is ``Style\/conceptual``, the symbol's name is rendered as \"conceptual\"---same as article names or tutorial names---where applicable. The default style is ``Style\/conceptual``."
20052005
},
20062006
{
20072007
"text" : ""
20082008
},
20092009
{
2010-
"text" : "When the ``style`` property is ``Style\/symbol``, the symbol's name is rendered as \"symbol\"same as article names or tutorial nameswhere applicable. The default style is ``Style\/conceptual``."
2010+
"text" : "When the ``style`` property is ``Style\/symbol``, the symbol's name is rendered as \"symbol\"---same as article names or tutorial names---where applicable. The default style is ``Style\/conceptual``."
20112011
},
20122012
{
20132013
"text" : ""
@@ -2247,34 +2247,34 @@
22472247
"docComment" : {
22482248
"lines" : [
22492249
{
2250-
"text" : "A directive that controls how the documentation-extension file merges with or overrides the in-source documentation."
2250+
"text" : "Defines whether the content in a documentation extension file amends or replaces in-source documentation."
22512251
},
22522252
{
22532253
"text" : ""
22542254
},
22552255
{
2256-
"text" : "When the ``behavior`` property is ``Behavior\/append``, the content from the documentation-extension file is added after the content from"
2256+
"text" : "By default, content from the documentation-extension file is added after the content from the in-source documentation for that symbol."
22572257
},
22582258
{
2259-
"text" : "the in-source documentation for that symbol."
2259+
"text" : ""
22602260
},
22612261
{
2262-
"text" : "If a documentation-extension file doesn't have a `DocumentationExtension` directive, then it has the ``Behavior\/append`` behavior."
2262+
"text" : "You get this default behavior in two cases:"
22632263
},
22642264
{
2265-
"text" : ""
2265+
"text" : "- when the documentation-extension file doesn't have a `DocumentationExtension` directive"
22662266
},
22672267
{
2268-
"text" : "When the ``behavior`` property is ``Behavior\/override``, the content from the documentation-extension file completely replaces the content"
2268+
"text" : "- when the `DocumentationExtension` directive explicitly specifies the ``Behavior\/append`` behavior"
22692269
},
22702270
{
2271-
"text" : "from the in-source documentation for that symbol"
2271+
"text" : ""
22722272
},
22732273
{
2274-
"text" : ""
2274+
"text" : "The other merge behavior completely replaces the content from the in-source documentation for that symbol with the content from the documentation-extension file. To get this behavior, specify ``Behavior\/override`` as the merge behavior."
22752275
},
22762276
{
2277-
"text" : "This directive is only valid within a ``Metadata`` directive:"
2277+
"text" : ""
22782278
},
22792279
{
22802280
"text" : "```"
@@ -2291,11 +2291,17 @@
22912291
{
22922292
"text" : "```"
22932293
},
2294+
{
2295+
"text" : ""
2296+
},
2297+
{
2298+
"text" : "The `DocumentationExtension` is only valid within a ``Metadata`` directive."
2299+
},
22942300
{
22952301
"text" : "- Parameters:"
22962302
},
22972303
{
2298-
"text" : " - mergeBehavior: The merge behavior for this documentation extension."
2304+
"text" : " - mergeBehavior: A value of `append` or `override`, denoting whether an extension file's content amends or replaces the in-source documentation."
22992305
},
23002306
{
23012307
"text" : " **(required)**"
@@ -4094,13 +4100,28 @@
40944100
"text" : ""
40954101
},
40964102
{
4097-
"text" : "If the page has moved more than once you can add multiple `Redirected` directives, each specifying one previous URL."
4103+
"text" : "If the page has moved more than once you can add multiple `Redirected` directives, each specifying one previous URL. For example:"
4104+
},
4105+
{
4106+
"text" : ""
4107+
},
4108+
{
4109+
"text" : "```md"
4110+
},
4111+
{
4112+
"text" : "@Redirected(from: \"old\/path\/to\/this\/page\")"
4113+
},
4114+
{
4115+
"text" : "@Redirected(from: \"another\/old\/path\/to\/this\/page\")"
4116+
},
4117+
{
4118+
"text" : "```"
40984119
},
40994120
{
41004121
"text" : ""
41014122
},
41024123
{
4103-
"text" : "> Note: Starting with version 5.11, the `Redirected` directive is supported both top-level and as a member of a ``Metadata`` directive. In"
4124+
"text" : "> Note: Starting with version 6.0, the `Redirected` directive is supported both top-level and as a member of a ``Metadata`` directive. In"
41044125
},
41054126
{
41064127
"text" : "earlier versions, the `Redirected` directive is only supported as a top-level directive."
@@ -4121,10 +4142,19 @@
41214142
"text" : ""
41224143
},
41234144
{
4124-
"text" : "To find each page's `Redirected` values, pass the `--emit-digest` flag to DocC and read the \"linkable-entities.json\" file that this makes DocC write to the output directory. "
4145+
"text" : "To find each page’s Redirected values, pass the `--emit-digest` flag to DocC."
4146+
},
4147+
{
4148+
"text" : "This flag configures DocC to write additional metadata files to the output directory."
4149+
},
4150+
{
4151+
"text" : "One of these files, `linkable-entities.json`, contains summarized information about all pages and on-page landmarks that you can link to from outside the DocC documentation."
4152+
},
4153+
{
4154+
"text" : "Each of these \"entities\" has a `\"path\"`---which represents the current relative path of that page---and an optional list of `\"redirects\"`---which represent all the `Redirected` values for page as they were authored in the markup."
41254155
},
41264156
{
4127-
"text" : "Each \"entity\" in that file has a \"path\"---which represents the current relative path of that page---and an optional list of \"redirects\"---which represent all the `Redirected` values for page as they were authored in the markup. You can write either relative redirect values or absolute redirect values depending on what information you need to set HTTP \"301 Moved Permanently\" redirects on your web server."
4157+
"text" : "You can write either relative redirect values or absolute redirect values in the markup depending on what information you need when setting up HTTP \"301 Moved Permanently\" redirects on your web server."
41284158
},
41294159
{
41304160
"text" : "- Parameters:"
@@ -5553,16 +5583,34 @@
55535583
"docComment" : {
55545584
"lines" : [
55555585
{
5556-
"text" : "A directive to set this page as a documentation root-level node."
5586+
"text" : "Configures an article to become a top-level page."
55575587
},
55585588
{
55595589
"text" : ""
55605590
},
55615591
{
5562-
"text" : "This directive is only valid within a top-level ``Metadata`` directive:"
5592+
"text" : "If your documentation only consists of articles, without any framework documentation or other top-level pages, DocC will use the only article or the article with the same base name as the documentation catalog ('.docc' directory) as the top-level page."
55635593
},
55645594
{
5565-
"text" : "```"
5595+
"text" : "If the documentation doesn't contain an article with the same base name as the documentation catalog, DocC will synthesize a minimal top-level page."
5596+
},
5597+
{
5598+
"text" : ""
5599+
},
5600+
{
5601+
"text" : "To customize which article is the top-level page of your documentation, add a `TechnologyRoot` directive within a `Metadata` directive in that article:"
5602+
},
5603+
{
5604+
"text" : ""
5605+
},
5606+
{
5607+
"text" : "```md"
5608+
},
5609+
{
5610+
"text" : "# Page Title"
5611+
},
5612+
{
5613+
"text" : ""
55665614
},
55675615
{
55685616
"text" : "@Metadata {"
@@ -5575,6 +5623,45 @@
55755623
},
55765624
{
55775625
"text" : "```"
5626+
},
5627+
{
5628+
"text" : ""
5629+
},
5630+
{
5631+
"text" : "> Earlier Versions:"
5632+
},
5633+
{
5634+
"text" : "> Before Swift-DocC 6.0, article-only documentation catalogs require one of the articles to be marked as a `TechnologyRoot`."
5635+
},
5636+
{
5637+
"text" : ""
5638+
},
5639+
{
5640+
"text" : "### Containing Elements"
5641+
},
5642+
{
5643+
"text" : ""
5644+
},
5645+
{
5646+
"text" : "The following items can include a technology root element:"
5647+
},
5648+
{
5649+
"text" : ""
5650+
},
5651+
{
5652+
"text" : "- ``Metadata``"
5653+
},
5654+
{
5655+
"text" : ""
5656+
},
5657+
{
5658+
"text" : "## See Also"
5659+
},
5660+
{
5661+
"text" : ""
5662+
},
5663+
{
5664+
"text" : "- <doc:formatting-your-documentation-content>"
55785665
}
55795666
]
55805667
},

Sources/docc/DocCDocumentation.docc/Reference Syntax/API Reference Syntax/Metadata.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Use the `Metadata` directive with the ``TitleHeading`` directive to configure th
4242
}
4343
```
4444

45-
Starting with version 5.11, use the `Metadata` directive with one or more ``Redirected`` directives
45+
Starting with version 6.0, use the `Metadata` directive with one or more ``Redirected`` directives
4646
to add additional URLs for a page.
4747
```
4848
# ``SlothCreator``
@@ -53,7 +53,7 @@ to add additional URLs for a page.
5353
}
5454
```
5555

56-
> Note: Starting with version 5.11, @Redirected is supported as a child directive of @Metadata. In
56+
> Note: Starting with version 6.0, @Redirected is supported as a child directive of @Metadata. In
5757
previous versions, @Redirected must be used as a top level directive.
5858

5959
## Topics
@@ -87,7 +87,7 @@ previous versions, @Redirected must be used as a top level directive.
8787

8888
- ``Redirected``
8989

90-
> Note: Starting with version 5.11, @Redirected is supported as a child directive of @Metadata. In
90+
> Note: Starting with version 6.0, @Redirected is supported as a child directive of @Metadata. In
9191
previous versions, @Redirected must be used as a top level directive.
9292

9393
<!-- Copyright (c) 2021-2024 Apple Inc and the Swift Project authors. All Rights Reserved. -->

0 commit comments

Comments
 (0)