Improve markdown files #1415
Merged
Improve markdown files #1415
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hamishknight
approved these changes
Jun 4, 2024
Member
Author
|
@swift-ci Please test |
Member
Author
|
@swift-ci Please test |
bnbarham
reviewed
Jun 4, 2024
README.md
Outdated
| ## Reporting Issues | ||
|
|
||
| 1. If you have installed Xcode 11.4+ or the corresponding Command Line Tools package, the SourceKit-LSP server is included and can be run with `xcrun sourcekit-lsp`. | ||
| If you should hit any issues while using SourceKit-LSP, we appreciate bug reports on [GitHub Issue](https://github.com/apple/swift-syntax/issues). |
Contributor
There was a problem hiding this comment.
Suggested change
| If you should hit any issues while using SourceKit-LSP, we appreciate bug reports on [GitHub Issue](https://github.com/apple/swift-syntax/issues). | |
| If you should hit any issues while using SourceKit-LSP, we appreciate bug reports on [GitHub Issue](https://github.com/apple/sourcekit-lsp/issues). |
CONTRIBUTING.md
Outdated
| ``` | ||
| > [!TIP] | ||
| > The PR description can be generated using the [release_branch.md](https://github.com/apple/swift-syntax/blob/main/.github/PULL_REQUEST_TEMPLATE/release_branch.md) [pull request template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates). To use this template when creating a PR, you need to add the query parameter: |
Contributor
There was a problem hiding this comment.
URL template won't work without adding this to sourcekit-lsp (in which case we should also change the URL here).
Member
Author
There was a problem hiding this comment.
I was adding it. Just forgot to change the URL. Stupid case-sensitive search 😬
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors.
Member
Author
|
@swift-ci Please test |
Member
Author
|
@swift-ci Please test Windows |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly just removing outdated information, merging files and pointing to the new tools page from swiftlang/swift-org-website#679 with instructions on how to set up editors