Skip to content
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
16 changes: 4 additions & 12 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
blank_issues_enabled: false
---
blank_issues_enabled: true
contact_links:
- name: "💬 Swift Documentation Forums"
- name: Swift Documentation Forums
url: "https://forums.swift.org/c/development/swift-docc/80"
about: "Discuss documentation content, propose major additions, or ask questions about Swift documentation"
- name: "🛠️ Documentation Tooling Forums"
url: "https://forums.swift.org/c/92"
about: "Questions about using Swift-DocC, documentation build tools, or authoring documentation"
- name: "📚 Swift Documentation Website"
url: "https://www.swift.org/documentation/"
about: "View the published Swift documentation"
- name: "📖 Contributing Guide"
url: "https://github.com/swiftlang/docs/blob/main/CONTRIBUTING.md"
about: "Read about style guidelines, proposing content, and the contribution process"
about: "Discuss documentation content or propose major additions"
47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE/content-error.yml

This file was deleted.

24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/content-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "Content Issue"
description: >-
Report an error, suggest an improvement,
or flag a problem with existing documentation
labels: ["triage needed"]
body:
- type: input
id: location
attributes:
label: "Page URL"
description: >-
Link to the page with the issue
placeholder: "https://www.swift.org/documentation/..."
validations:
required: false

- type: textarea
id: description
attributes:
label: "Description"
description: "What's wrong or what could be better?"
validations:
required: true
52 changes: 9 additions & 43 deletions .github/ISSUE_TEMPLATE/content-proposal.yml
Original file line number Diff line number Diff line change
@@ -1,56 +1,22 @@
---
name: "Content Proposal"
description: "Propose new documentation topics or articles"
labels: ["content proposal", "needs forum discussion"]
labels: ["content proposal"]
body:
- type: markdown
attributes:
value: |
Thank you for proposing new Swift documentation!
For significant new content, consider starting
a discussion on the
[Swift Forums][1] first.

For significant new content, please consider starting a discussion on the
[Swift Forums](https://forums.swift.org/c/development/swift-docc/80) first.

See our [Contributing Guide](https://github.com/swiftlang/docs/blob/main/CONTRIBUTING.md)
for guidance on proposing larger content additions.

- type: dropdown
id: package
attributes:
label: "Target Package"
description: "Which package should contain this new content?"
options:
- API Guidelines
- Language Guides
- Server Guides
- Ecosystem Tools
- New package needed
- Not sure
validations:
required: true

- type: input
id: location
attributes:
label: "Suggested Location"
description: "Where should this content be added? (chapter, section, or new article)"
placeholder: "e.g., 'Language Guides > Concurrency' or 'New article in Server Guides'"
validations:
required: false
[1]: https://forums.swift.org/c/development/swift-docc/80

- type: textarea
id: description
attributes:
label: "Content Description"
description: "What should this new documentation cover?"
placeholder: "Provide a clear summary of the proposed content"
validations:
required: true

- type: textarea
id: motivation
attributes:
label: "Motivation"
description: "Why is this documentation needed?"
placeholder: "What problem does this solve? What audience would benefit?"
label: "What documentation is needed?"
description: >-
Describe the topic and who would benefit
validations:
required: true
58 changes: 0 additions & 58 deletions .github/ISSUE_TEMPLATE/enhancement.yml

This file was deleted.

75 changes: 0 additions & 75 deletions .github/ISSUE_TEMPLATE/task.yml

This file was deleted.

31 changes: 5 additions & 26 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,12 @@
## Summary

<!-- Provide a clear description of what this PR changes and why -->
<!-- What does this PR change and why? -->


## Related Issue

<!-- Link to the issue this PR addresses -->
Closes: #


## Testing

<!-- How can reviewers verify these changes? -->

### Build Verification
- [ ] Ran `swift package generate-documentation --analyze --warnings-as-errors` successfully
- [ ] Previewed documentation locally with `swift package --disable-sandbox preview-documentation`

### Content Review
- [ ] Changes follow the [Apple Style Guide](https://help.apple.com/applestyleguide/)
- [ ] Changes follow [TSPL style guidelines](https://github.com/swiftlang/swift-book/blob/main/Style.md#terms-and-rules)
- [ ] Code examples compile and run as expected
- [ ] Links and cross-references are valid

## Additional Notes

<!-- Any additional context, screenshots, or information for reviewers -->
## Validation

- [ ] `swift package generate-documentation --analyze --warnings-as-errors` passes
- [ ] Previewed locally with `swift package --disable-sandbox preview-documentation`

---
<!-- Do not edit below this line -->
**By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.**
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Loading