Skip to content

Commit be6c42a

Browse files
authored
Merge branch 'main' into patch-2
2 parents 642c4f3 + 2061107 commit be6c42a

File tree

4 files changed

+42
-9
lines changed

4 files changed

+42
-9
lines changed

.well-known/atproto-dtd.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
type: text/plain
3+
---
4+
did:plc:5mxqysxzortsy4ohbj5dfd6r

_config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,6 @@ plugins:
2626

2727
whitelist:
2828
- jekyll-redirect-from
29+
30+
include:
31+
- .well-known

gsoc2025/index.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -303,9 +303,9 @@ Enhance Swift Testing's reporting of test results to the console/terminal. Consi
303303

304304
- [Stuart Montgomery](https://github.com/stmontgomery)
305305

306-
### Documentation coverage
306+
### Improved command line tool documentation
307307

308-
**Project size**: 90 hours (small)
308+
**Project size**: 175 hours (medium)
309309

310310
**Estimated difficulty**: Intermediate
311311

@@ -315,20 +315,46 @@ Enhance Swift Testing's reporting of test results to the console/terminal. Consi
315315

316316
**Description**
317317

318-
Enhance Swift DocC's experimental documentation coverage feature to write coverage metrics in a new extensible format that other tools can read and display.
319-
Define a few types of metrics—for example Boolean (has documentation: true/false), Fraction (2/3 parameters are documented), Percentage, etc.—for this format.
320-
Explore ideas for what documentation coverage information would be useful to emit. Explore ideas for how another tool could display that coverage information.
318+
Swift Argument Parser recently added a [command plugin](https://github.com/apple/swift-argument-parser/pull/694) to generate documentation markup for a command line tool.
319+
This plugin could be improved by providing support for generating separate pages for each command and by leveraging additional markdown syntax to organize command line flags into sections and display possible values and default values.
320+
321+
Beyond the markdown output, this plugin could be further improved by generating a ["symbol graph"](https://github.com/swiftlang/swift-docc-symbolkit/tree/main) that describe each command and its flags, options, and subcommands. By describing the commands' structure, tools like [Swift DocC](https://github.com/swiftlang/swift-docc/tree/main) can further customize the display of command line tool documentation, support links to individual flags, and allow developers to extend or override the documentation for individual flags in ways that isn't overwritten when regenerating the documentation markup from the plugin. If time allows, prototype some enhancement to command line documentation in Swift DocC that leverage the information from the command symbol graph file.
321322

322323
**Expected outcomes/benefits/deliverables**
323324

324-
- Land the documentation coverage output format changes for the experimental feature in DocC.
325-
- Submit a pitch to the community and the Documentation Workgroup to formally enable the documentation coverage feature in DocC.
326-
- Summarize your effort with a demo of the new metrics and examples of how another tool could display that information.
325+
- A richer markdown output from the plugin.
326+
- Support for generating separate pages for each command.
327+
- Output a supplementary symbol graph file that describe the commands' structure.
327328

328329
**Potential mentors**
329330

330331
- [David Rönnqvist](https://github.com/d-ronnqvist)
331332

333+
### Documentation coverage
334+
335+
**Project size**: 90 hours (small)
336+
337+
**Estimated difficulty**: Intermediate
338+
339+
**Recommended skills**
340+
341+
- Basic proficiency in Swift.
342+
343+
**Description**
344+
345+
Enhance Swift DocC's experimental documentation coverage feature to write coverage metrics in a new extensible format that other tools can read and display.
346+
Define a few types of metrics—for example Boolean (has documentation: true/false), Fraction (2/3 parameters are documented), Percentage, etc.—for this format.
347+
Explore ideas for what documentation coverage information would be useful to emit. Explore ideas for how another tool could display that coverage information.
348+
349+
**Expected outcomes/benefits/deliverables**
350+
351+
- Land the documentation coverage output format changes for the experimental feature in DocC.
352+
- Submit a pitch to the community and the Documentation Workgroup to formally enable the documentation coverage feature in DocC.
353+
- Summarize your effort with a demo of the new metrics and examples of how another tool could display that information.
354+
355+
**Potential mentors**
356+
357+
- [David Rönnqvist](https://github.com/d-ronnqvist)
332358

333359
### Example project name
334360

index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ atom: true
1717
</div>
1818

1919
<div class="banner primary">
20-
<p>Get ready for the Swift 6 language mode with the <a href="https://www.swift.org/migration/">official migration guide</a></p>
20+
<p>Swift 6 is here! Learn about the new language mode with the <a href="https://www.swift.org/migration/documentation/migrationguide/">official migration guide</a>.</p>
2121
</div>
2222

2323
<div class="link-grid">

0 commit comments

Comments
 (0)