Skip to content

Instructions for generating DocC for diagnostics #80857

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.

Sign up for GitHub

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
Apr 18, 2025
Merged

Instructions for generating DocC for diagnostics #80857

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/Diagnostics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ Diagnostic group documentation should:
- Include references to relevant chapters of _The Swift Programming Language_.
- Be written in Markdown, but avoid excessive markup which negatively impacts the terminal UX.

The diagnostic group documentation supports generating a DocC bundle for hosting. You can currently find the compiler diagnostics documentation at https://docs.swift.org/compiler/documentation/diagnostics/

To generate this documentation locally, run the following command from the root of the repository:
```
docc preview --allow-arbitrary-catalog-directories userdocs/diagnostics
```


### Quick-Start Guide for Contributing New Diagnostic Groups ###

Adding new diagnostic groups is a great way to get familiar with the process of contributing to Swift, while also making a big impact!
Expand Down