---
# System prepended metadata

title: 'PSA: Rustdoc Changes'

---

# PSA: Rustdoc Changes

tl;dr: Fuchsia's rustdoc instance is now faster, more helpful, and more complete. Give it a try at [fuchsia.dev/go/rustdoc][new-index]!

## 1. New index page

We now have a landing page for [go/rvos-rustdoc](https://fuchsia.dev/go/rustdoc) featuring a categorized list of useful crates. The full list of crates is on the left-hand side.

## 2. Goodbye, missing documentation!

There used to be a _lot_ of crates whose docs didn't build. We've increased the success rate of docs builds from less than 50% to over 96%. If you previously didn't use the docs because you couldn't find your library, check again and report issues [here][issues].

## 3. Split host and target docs

There are now separate docs "universes" for Fuchsia and host documentation. Some libraries are only enabled on particular targets or change their API with conditional compilation.

If you are developing on host, follow links for the [host target](https://fuchsia.dev/go/rustdoc/host) to get more complete docs.

Before we were just generating docs for fuchsia, even for crates that should only be used on host. Now they're split and all item links between crates will go to their correct versions.

## 4. Open-source friendly shortlinks

[fuchsia.dev/go/rustdoc][new-index] is a new shortlink to our docs instance. You can use it interchangeably with [go/rvos-rustdoc][new-index], but it works outside corp so you can use it in open source contexts like bugs and CLs.

We've also set up redirects such that links like [go/rvos-rustdoc/fuchsia_async](https://fuchsia.dev/go/rustdoc/fuchsia_async) and [go/rvos-rustdoc/host/ffx_daemon_core/events](https://fuchsia.dev/go/rustdoc/host/ffx_daemon_core/events) will send you to the correct place.

## 5. Faster + less noisy search

We've removed lots of test/benchmark/binary targets from the docs, which has significantly improved the speed and accuracy of the search results.

If you're writing a library that no one will need to depend on (such as a fuzzer), you can set `disable_rustdoc = true` in your BUILD.gn and your library won't be added ([example](https://fxrev.dev/858669)).

Docs also update faster now, due to the thousands of unwanted crates we've excluded. After landing a docs change it'll be reflected within 2-4 hours (down from 3-6 hours).


## Shoutouts

The new index page was written by nickvander@ with help from adamperry@ and the Rust Working Group.

computerdruid@ helped drive the effort to split the docs and bring the failure rate under 5%.


## What's next

- Check out the [new index page][new-index]
- File issues for [missing or broken docs][issues]
- Look out for a docs fix-it next month


[issues]: https://b.corp.google.com/issues/new?component=1368932
[new-index]: https://fuchsia.dev/go/rustdoc