File tree Expand file tree Collapse file tree 2 files changed +21
-0
lines changed Expand file tree Collapse file tree 2 files changed +21
-0
lines changed Original file line number Diff line number Diff line change 1
1
/target
2
2
Cargo.lock
3
+ .vscode
Original file line number Diff line number Diff line change
1
+ ## How to test docs.rs changes
2
+
3
+ Set up your local docs.rs environment as per official README:
4
+ https://github.com/rust-lang/docs.rs?tab=readme-ov-file#getting-started
5
+
6
+ Make sure you have:
7
+ - Your .env contents exported
8
+ - docker-compose for db and s3 running
9
+ - The web server running via local (or pure docker-compose approach)
10
+ - If on a remote machine, port 3000 (or whatever your webserver is listening on) forwarded
11
+
12
+ Invoke the build command against your local path:
13
+
14
+ ```
15
+ # you could also point to the `cratesfyi` binary from outside of the docker workspace,
16
+ # though you'll still need the right ENVs exported
17
+ cargo run -- build crate --local ../tokio-metrics
18
+ ```
19
+
20
+ View the generated documentation for ` tokio-metrics ` in your browser
You can’t perform that action at this time.
0 commit comments