Skip to content

Migrate documentation for Usage to DocC #8593

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

Jump to bottom
Open
bripeticca opened this issue May 1, 2025 · 0 comments · May be fixed by #8734
Open

Migrate documentation for Usage to DocC #8593

bripeticca opened this issue May 1, 2025 · 0 comments · May be fixed by #8734
Assignees
@heckj
Labels
documentation enhancement

Comments

@bripeticca
Copy link
Contributor

bripeticca commented May 1, 2025 •
edited by heckj
Loading

Description

In an effort to create a consolidated single source for the swift package manager documentation, this issue will track the work to be done in moving the contents of Usage.md into our DocC catalogue.

Each of the top level section headings in Usage.md maps pretty effectively to its own article:

  * [Creating a Package](#creating-a-package)
    * [Creating a Library Package](#creating-a-library-package)
    * [Creating an Executable Package](#creating-an-executable-package)
    * [Creating a Macro Package](#creating-a-macro-package)
  * [Defining Dependencies](#defining-dependencies)
  * [Publishing a Package](#publishing-a-package)
  * [Requiring System Libraries](#requiring-system-libraries)
  * [Packaging Legacy Code](#packaging-legacy-code)
  * [Handling Version-specific Logic](#handling-version-specific-logic)
  * [Editing a Package](#editing-a-package)
    * [Top of Tree Development](#top-of-tree-development)
  * [Resolving Versions (Package.resolved file)](#resolving-versions-packageresolved-file)
  * [Setting the Swift Tools Version](#setting-the-swift-tools-version)
  * [Testing](#testing)
  * [Running](#running)
  * [Setting the Build Configuration](#setting-the-build-configuration)
    * [Debug](#debug)
    * [Release](#release)
    * [Additional Flags](#additional-flags)
  * [Depending on Apple Modules](#depending-on-apple-modules)
  * [Creating C Language Targets](#creating-c-language-targets)
  * [Using Shell Completion Scripts](#using-shell-completion-scripts)

The first step of this is directly porting - and not updating - the content for these topics, creating loosely 12-14 short articles.
@heckj heckj self-assigned this May 1, 2025
This was referenced May 19, 2025
Closed
Merged
heckj added a commit that referenced this issue May 27, 2025
@heckj @owenv
Partial migration of Usage.md - topics related to dependencies and C …
3eac931 
…language modules (#8709)

Migrating content from documentation/Usage.md into DocC:

New articles:
- AddingDependencies.md
- CreatingCLanguageTargets.md
- ResolvingPackageVersions.md
- Dependencies/AddingSystemLibraryDependency.md
- Dependencies/ExampleSystemLibraryPkgConfig.md
- Dependencies/ExampleSystemLibraryWithoutPkgConfig.md
- Dependencies/ResolvingDependencyFailures.md

And updates to Documentation.md for curating them into the collection as
guides.

partial work against #8593

---------

Co-authored-by: Owen Voorhees <[email protected]>
@heckj heckj linked a pull request May 28, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heckj heckj

Labels
documentation enhancement
Projects
None yet
Milestone
No milestone
2 participants
@heckj @bripeticca