Skip to content

Collapse Documentation Folder #1094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions Documentation/README.md

This file was deleted.

5 changes: 0 additions & 5 deletions Documentation/SwiftParser.md

This file was deleted.

19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,20 @@ Replace `<#Specify Release tag#>` by the version of SwiftSyntax that you want to

## Documentation

Documentation can be found in the following places:
- For the parser: [Sources/SwiftParser/SwiftParser.docc](Sources/SwiftParser/SwiftParser.docc)
- 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
- General documentation: [Documentation](Documentation)
- Examples of using SwiftSyntax: [Examples](Examples).
SwiftSyntax uses [DocC](https://developer.apple.com/documentation/docc) bundles
for its documentation. To view rendered documentation in Xcode, open the
SwiftSyntax package and select

```
Product > Build Documentation
```

Associated articles are written in markdown, and can be viewed in a browser,
text editor, or IDE.

- [SwiftSyntax](Sources/SwiftSyntax/Documentation.docc)
- [SwiftParser](Sources/SwiftParser/SwiftParser.docc)
- [SwiftOperators](Sources/SwiftOperators/SwiftOperators.docc)

## Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ allows Swift tools to parse, inspect, generate, and transform Swift source code.
### Articles

- <doc:ChangingSwiftSyntax>
- <doc:Create-SwiftSyntax-Release>

### Syntax

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ allows Swift tools to parse, inspect, generate, and transform Swift source code.
### Articles

- <doc:ChangingSwiftSyntax>
- <doc:Create-SwiftSyntax-Release>

### Syntax

Expand Down