Migrate remaining content from documentation/Usage.md into DocC articles #8734
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
heckj
requested review from
jakepetroules,
dschaefer2,
shawnhyam and
bripeticca
as code owners
heckj
requested review from
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
|
@swift-ci please test |
bripeticca
requested changes
May 29, 2025
Sources/PackageManagerDocs/Documentation.docc/BundlingResources.md
Outdated
Show resolved
Hide resolved
|
|
||
| In general, avoid placing files that aren’t resources in a target’s source folder. | ||
| If that’s not feasible, avoid excluding every file individually, place all files you want to exclude in a directory, and add the directory path to the array of excluded files. | ||
| Swift Package Manager warns you about files it doesn't recognize in a target's `Sources` directory. |
There was a problem hiding this comment.
question: Since we're avoiding the use of SwiftPM in the docs, are Swift Package Manager and the package manager used interchangeably as replacements to SwiftPM? Do we prefer one over the other?
There was a problem hiding this comment.
I've been leaning into "package manager", generally assuming that within these articles, the Swift part is heavily assumed and redundant. I've been switching it away from being referenced as a proper noun in general.
Sources/PackageManagerDocs/Documentation.docc/SwiftVersionSpecificPackaging.md
Outdated
Show resolved
Hide resolved
bripeticca
approved these changes
May 29, 2025
|
@swift-ci please test |
MaxDesiatov
reviewed
May 30, 2025
Sources/PackageManagerDocs/Documentation.docc/BundlingResources.md
Outdated
Show resolved
Hide resolved
MaxDesiatov
reviewed
May 30, 2025
Sources/PackageManagerDocs/Documentation.docc/BundlingResources.md
Outdated
Show resolved
Hide resolved
MaxDesiatov
reviewed
May 30, 2025
Sources/PackageManagerDocs/Documentation.docc/BundlingResources.md
Outdated
Show resolved
Hide resolved
MaxDesiatov
reviewed
May 30, 2025
Sources/PackageManagerDocs/Documentation.docc/BundlingResources.md
Outdated
Show resolved
Hide resolved
MaxDesiatov
reviewed
May 30, 2025
Sources/PackageManagerDocs/Documentation.docc/UsingShellCompletion.md
Outdated
Show resolved
Hide resolved
MaxDesiatov
reviewed
May 30, 2025
Sources/PackageManagerDocs/Documentation.docc/UsingShellCompletion.md
Outdated
Show resolved
Hide resolved
|
@swift-ci please test |
heckj
force-pushed
the
docs/migrate-usage-remaining
branch
from
4801c15 to
61470cf
Compare
|
@swift-ci please test |
…s.md Co-authored-by: Bri Peticca <briannap_22@apple.com>
…ificPackaging.md Co-authored-by: Bri Peticca <briannap_22@apple.com>
…s.md Co-authored-by: Max Desiatov <m_desiatov@apple.com>
…s.md Co-authored-by: Max Desiatov <m_desiatov@apple.com>
…s.md Co-authored-by: Max Desiatov <m_desiatov@apple.com>
…tion.md Co-authored-by: Max Desiatov <m_desiatov@apple.com>
…tion.md Co-authored-by: Max Desiatov <m_desiatov@apple.com>
…s.md Co-authored-by: Max Desiatov <m_desiatov@apple.com>
heckj
force-pushed
the
docs/migrate-usage-remaining
branch
from
61470cf to
2b20de6
Compare
|
@swift-ci please test |
|
@swift-ci please test linux platform self hosted |
|
@swift-ci please test windows |
|
@swift-ci please test linux |
|
@swift-ci please test windows self hosted |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Migrate remaining content from documentation/Usage.md into DocC articles
Motivation:
Migrate existing documentation from plain markdown into DocC and slightly update content when outdated.
Modifications:
Added the following new articles:
Updated the following articles to accommodate the new articles:
resolves #8593