Skip to content

Commit e3e7b33

Browse files
authored
Merge pull request #1094 from CodaFi/subdoxastic
2 parents a820410 + b9d3cbe commit e3e7b33

File tree

6 files changed

+16
-31
lines changed

6 files changed

+16
-31
lines changed

Documentation/README.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

Documentation/SwiftParser.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,20 @@ Replace `<#Specify Release tag#>` by the version of SwiftSyntax that you want to
7272

7373
## Documentation
7474

75-
Documentation can be found in the following places:
76-
- For the parser: [Sources/SwiftParser/SwiftParser.docc](Sources/SwiftParser/SwiftParser.docc)
77-
- You can either directly view this documentation on GitHub or build a documentation bundle by opening the project in Xcode and clicking Product -> Build Documentation
78-
- General documentation: [Documentation](Documentation)
79-
- Examples of using SwiftSyntax: [Examples](Examples).
75+
SwiftSyntax uses [DocC](https://developer.apple.com/documentation/docc) bundles
76+
for its documentation. To view rendered documentation in Xcode, open the
77+
SwiftSyntax package and select
78+
79+
```
80+
Product > Build Documentation
81+
```
82+
83+
Associated articles are written in markdown, and can be viewed in a browser,
84+
text editor, or IDE.
85+
86+
- [SwiftSyntax](Sources/SwiftSyntax/Documentation.docc)
87+
- [SwiftParser](Sources/SwiftParser/SwiftParser.docc)
88+
- [SwiftOperators](Sources/SwiftOperators/SwiftOperators.docc)
8089

8190
## Contributing
8291

Sources/SwiftSyntax/Documentation.docc/SwiftSyntax.md.gyb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ allows Swift tools to parse, inspect, generate, and transform Swift source code.
2424
### Articles
2525

2626
- <doc:ChangingSwiftSyntax>
27+
- <doc:Create-SwiftSyntax-Release>
2728

2829
### Syntax
2930

Sources/SwiftSyntax/Documentation.docc/gyb_generated/SwiftSyntax.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ allows Swift tools to parse, inspect, generate, and transform Swift source code.
1717
### Articles
1818

1919
- <doc:ChangingSwiftSyntax>
20+
- <doc:Create-SwiftSyntax-Release>
2021

2122
### Syntax
2223

0 commit comments

Comments
 (0)