Skip to content

Commit dca55f5

Browse files
committed
update guides since unidoc is a single binary now
1 parent fa3f590 commit dca55f5

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

Guides/docs.docc/Getting started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ A fresh Unidoc database contains no documentation. Let’s build some now.
9494

9595
The documentation compiler lives in this repository, and is packaged as a normal SwiftPM executable target.
9696

97-
To invoke the compiler, run the `unidoc-build` tool and pass it the name of the package you want to build documentation for. In our case, the “package” is `swift`, which is a special name identifying the standard library itself.
97+
To invoke the compiler, run the `unidoc local` tool and pass it the name of the package you want to build documentation for. In our case, the “package” is `swift`, which is a special name identifying the standard library itself.
9898

9999
@Code(file: load-standard-library.sh, title: load-standard-library.sh)
100100

@@ -130,7 +130,7 @@ git clone https://github.com/apple/swift-nio
130130

131131
**Where** you clone the repository is important, because you will need to tell Unidoc where to find the project. In this example, we cloned the repository inside a directory called `/swift`, which is a plausible place to store Git repositories in a devcontainer.
132132

133-
Next, you can try building `swift-nio` with `unidoc-build`, specifying the path to the search directory (`/swift`) with the `-I` option.
133+
Next, you can try building `swift-nio` with `unidoc local`, specifying the path to the search directory (`/swift`) with the `-I` option.
134134

135135
@Code(file: load-swift-nio.sh, title: load-swift-nio.sh)
136136

Guides/docs.docc/Quickstart.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Previewing documentation locally
22

3-
This guide walks through how to use the `unidoc-preview` tool to preview documentation locally on macOS 14. This guide won’t make any effort to explain how Unidoc itself works, it is merely intended to demonstrate how to preview multi-package documentation as quickly as possible. For a more-detailed Linux-centric tour, see the <doc:Getting-started> guide.
3+
This guide walks through how to use the `unidoc preview` tool to preview documentation locally on macOS 14. This guide won’t make any effort to explain how Unidoc itself works, it is merely intended to demonstrate how to preview multi-package documentation as quickly as possible. For a more-detailed Linux-centric tour, see the <doc:Getting-started> guide.
44

55
In this guide, you will:
66

77
1. Launch and initialize a `mongod` instance in a Docker container,
8-
2. Build and run an instance of `unidoc-preview` on the macOS host,
9-
3. Build the `unidoc-build` tool,
8+
2. Build and run an instance of `unidoc preview` on the macOS host,
9+
3. Build the `unidoc local` tool,
1010
4. Generate documentation for the standard library, and
1111
5. Generate documentation for two SwiftPM packages, one of which depends on the other.
1212

@@ -44,23 +44,23 @@ docker exec -t unidoc-mongod-container /bin/mongosh --file /unidoc-rs-init.js
4444
```
4545

4646

47-
## 3. Running `unidoc-preview`
47+
## 3. Running `unidoc preview`
4848

49-
The `unidoc-preview` tool is an ordinary SwiftPM executable product. You can build and run it directly from your macOS host like this:
49+
The `unidoc preview` tool is an ordinary SwiftPM executable product. You can build and run it directly from your macOS host like this:
5050

5151
```bash
52-
swift run -c release unidoc-preview
52+
swift run -c release unidoc-tools preview
5353
```
5454

55-
The `unidoc-preview` tool will start a web server on [`http://localhost:8080`](http://localhost:8080).
55+
The `unidoc preview` tool will start a web server on [`http://localhost:8080`](http://localhost:8080).
5656

5757
@Image(source: "Start page.png", alt: "Start page") {
58-
> The `unidoc-preview` start page.
58+
> The `unidoc preview` start page.
5959
}
6060

6161
## 4. Generating documentation for the standard library
6262

63-
Generate local documentation using the `unidoc-build local` subcommand. To start off, open a third terminal and generate the documentation for the standard library (`swift`).
63+
Generate local documentation using the `unidoc local` subcommand. To start off, open a third terminal and generate the documentation for the standard library (`swift`).
6464

6565
@Code(file: load-standard-library.sh, title: load-standard-library.sh)
6666

@@ -84,7 +84,7 @@ cd -
8484
Generating documentation for a package is similar to generating documentation for the standard library, except you need to specify a search path to a directory containing the project. Because you downloaded the `swift-collections` repository to a sibling directory, you can use `..` for the search path.
8585

8686
```bash
87-
swift run -c release unidoc-build local swift-collections -I ..
87+
swift run -c release unidoc-tools local swift-collections -I ..
8888
```
8989

9090
You should be able to view the symbol graph and its documentation at [`http://localhost:8080/tags/swift-collections`](http://localhost:8080/tags/swift-collections).
@@ -99,7 +99,7 @@ Finally, let’s generate documentation for a package that depends on `swift-col
9999
cd ..
100100
git clone https://github.com/apple/swift-async-algorithms
101101
cd -
102-
swift run -c release unidoc-build local swift-async-algorithms -I ..
102+
swift run -c release unidoc-tools local swift-async-algorithms -I ..
103103
```
104104

105105

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
swift run -c release unidoc-build local swift
1+
swift run -c release unidoc-tools build local swift
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
swift run -c release unidoc-build local swift-nio -I /swift
1+
swift run -c release unidoc-tools build local swift-nio -I /swift
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
swift --version
2-
swift run -c release unidoc-preview
2+
swift run -c release unidoc-tools preview

0 commit comments

Comments
 (0)