Skip to content

Migrate documentation for README to DocC #8595

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
Closed
bripeticca opened this issue May 1, 2025 · 0 comments · Fixed by #8621
Closed

Migrate documentation for README to DocC #8595

bripeticca opened this issue May 1, 2025 · 0 comments · Fixed by #8621
Assignees
@heckj
Labels
documentation enhancement

Comments

@bripeticca
Copy link
Contributor

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 README.md into our DocC catalogue.

Expected behavior

No response

Actual behavior

No response

Steps to reproduce

No response

Swift Package Manager version/commit hash

No response

Swift & OS version (output of swift --version && uname -a)

No response
@heckj heckj self-assigned this May 1, 2025
@heckj heckj mentioned this issue May 5, 2025
Merged
heckj added a commit that referenced this issue May 16, 2025
@heckj
Migrate README (#8621)
57ce13a 
Docs Migration Work

### Motivation:

resolves #8595

### Modifications:

- named top-level organization file to `Documentation.md` to make it
easier to spot.
- migrate content from Documentation/README primarily into a top-level
article "Introducing Packages".
- migrated the dependency failure scenarios into it's own article
(Exploring your package's dependencies).
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
Development

Successfully merging a pull request may close this issue.

Migrate README heckj/swift-package-manager
2 participants
@heckj @bripeticca