6 Commits

Author SHA1 Message Date
rwa
2ace0b56c1 docs: fix warning styles in html-in-header (#2449)
## Motivation

The documentation under https://tracing.rs/tracing/ is missing CSS
styles. Fixes #2444 

## Solution

Used the `--html-in-header` rustdoc flag instead of `--extend-css`.
Converted the css file into an html file.
2023-02-08 10:25:22 -08:00
Eliza Weisman
e0d130e5c0 chore: add a warning header to docs built from master (#1765)
This branch adds a warning header to documentation built from the
`master` branch, noting that this is _not_ documentation for the release
version, and suggesting that users refer to docs.rs for the release
documentation instead. Netlify is configured to include this header when
building documentation. This should make it clearer that documentation
built from `master` does _not_ document the currently documented release
versions on crates.io.

I'm very far from a web developer, so it's almost certainly possible
that the warning header could look nicer. I'll happily take suggestions
for improving the styling, but at least this gets the point across.

Additionally, I've added a [`noindex` meta tag][1] to the documentation's
HTML `<head>`. This should prevent it from showing up in search engines,
so that when people Google tracing APIs, they end up on the docs.rs
documentation, rather than the `master` branch dev docs.

You can see what it looks like in the netlify deploy preview, but basically,
it looks like this: 
![image](https://user-images.githubusercontent.com/2796466/144482665-908cbaee-076e-441b-8689-1e6cd1b03f31.png)

Closes #1592

[1]: https://developers.google.com/search/docs/advanced/crawling/block-indexing
2021-12-03 11:09:55 -08:00
xd009642
f841b579cb docs: add favicon for extra pretty docs (#1033)
A PR to make the docs extra swish via a favicon for the browser tab!

Before 

![image](https://user-images.githubusercontent.com/3472518/95902628-f7dd7380-0d8c-11eb-855a-f6530103917d.png)

After

![image](https://user-images.githubusercontent.com/3472518/95902709-0f1c6100-0d8d-11eb-85f7-49cdf36473ac.png)
2020-10-13 16:02:09 -07:00
Eliza Weisman
f470db1b03 docs: add a version of the logo with text (#953)
This changes the logo to a wordmark. This should be consistent
with the ones for all the other Tokio crates, when we add them
elsewhere.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
2020-08-24 15:55:00 -07:00
Eliza Weisman
63c0f317f9 docs: add splash image to the main README (#895)
This branch adds an SVG splash graphic to the main
repository readme, based on the illustration on tokio.rs.

I thought about sticking a big "As seen in rustc!" on there,
and we *could* still do this...

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
2020-08-07 09:39:52 -07:00
Eliza Weisman
add986d651 chore: add tracing logo to RustDoc (#832)
Now that the new https://tokio.rs is live, we can add the new Tracing
logo to the RustDoc!

I also added a couple missing `html_root_url` attributes in published
crates.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
2020-07-21 14:25:36 -07:00