Skip to content

Commit 1e1fecb

Browse files
authored
stubs for initial DocC structure (#8572)
Placeholder structure for DocC content to lay out an initial area to build into. ### Motivation: @bripeticca and I wanted to have something in place to merge into and a general plan of attack for shifting current content from the `/documentation` directory into DocC format. This provides a bit more structure over the bare docc catalog, and puts in placeholders for the CLI documentation as well. We'll be creating issues for each of the existing markdown files in `/documentation`, and one for each cluster of CLI commands (grouped by top-level subcommand) to track progress. ### Modifications: This drops in place some light DocC content, with no real depth, to set up an initial structure to merge content into. This isn't merging any existing documentation ### Result: The PackageManagerDocs target has more concrete content layout structure to it, with placeholders for CLI commands and where to expand to build out article sets based on existing documentation. Use `swift package --disable-sandbox preview-documentation --target PackageManagerDocs` with this PR to get a sense of the layout. <img width="1416" alt="Screenshot 2025-04-29 at 2 19 10 PM" src="https://github.com/user-attachments/assets/47875e36-c085-4bda-89a0-dcdde30f27c6" />
1 parent e84c0ba commit 1e1fecb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+942
-1
lines changed
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Getting Started
2+
3+
Learn to create and use a Swift package.
4+
5+
## Overview
6+
7+
overview content here....
8+
9+
### First Section
10+
11+
First section content
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Introducing Packages
2+
3+
Learn to create and use a Swift package.
4+
5+
## Overview
6+
7+
overview content here....
8+
9+
### First Section
10+
11+
First section content
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# swift package add-dependency
2+
3+
Add a package dependency to the manifest.
4+
5+
@Metadata {
6+
@PageImage(purpose: icon, source: command-icon)
7+
}
8+
9+
## Overview
10+
11+
overview content here....
12+
13+
### First Section
14+
15+
First section content
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# swift package add-product
2+
3+
Add a new product to the manifest.
4+
5+
@Metadata {
6+
@PageImage(purpose: icon, source: command-icon)
7+
}
8+
9+
## Overview
10+
11+
overview content here....
12+
13+
### First Section
14+
15+
First section content
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# swift package add-target
2+
3+
Add a new target to the manifest.
4+
5+
@Metadata {
6+
@PageImage(purpose: icon, source: command-icon)
7+
}
8+
9+
## Overview
10+
11+
overview content here....
12+
13+
### First Section
14+
15+
First section content
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# swift package add-target-dependency
2+
3+
Add a new target dependency to the manifest.
4+
5+
@Metadata {
6+
@PageImage(purpose: icon, source: command-icon)
7+
}
8+
9+
## Overview
10+
11+
overview content here....
12+
13+
### First Section
14+
15+
First section content
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# swift package archive-source
2+
3+
Create a source archive for the package.
4+
5+
@Metadata {
6+
@PageImage(purpose: icon, source: command-icon)
7+
}
8+
9+
## Overview
10+
11+
overview content here....
12+
13+
### First Section
14+
15+
First section content
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# swift package clean
2+
3+
Delete build artifacts.
4+
5+
@Metadata {
6+
@PageImage(purpose: icon, source: command-icon)
7+
}
8+
9+
## Overview
10+
11+
overview content here....
12+
13+
### First Section
14+
15+
First section content

0 commit comments

Comments
 (0)