Commit graph

3 commits

Author SHA1 Message Date
Justin Duke
e3b07631ce
Fix broken link in docs (#1830)
Describe what your pull request does. If appropriate, add GIFs or images
showing the before and after.

### Change Type

- [ ] `patch` — Bug fix
- [ ] `minor` — New feature
- [ ] `major` — Breaking change
- [ ] `dependencies` — Changes to package dependencies[^1]
- [x] `documentation` — Changes to the documentation only[^2]
- [ ] `tests` — Changes to any test code only[^2]
- [ ] `internal` — Any other changes that don't affect the published
package[^2]
- [ ] I don't know

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-08-28 08:21:13 +00:00
Lu Wilson
a316fd2ab4
Add API links to all docs pages (#1661)
This PR adds links to the API reference from within the docs pages.
I think we should continue with this as we move forwards with more
content.

We could tweak the threshold of what we link or don't link. I tried to
strike a good balance (maybe linked too much though). We'd want lots of
stuff to be clickable, so that users can dive into the API. But we don't
want the screen to be a splattering of blue, distracting away from more
important stuff.

### Change Type

- [x] `documentation` — Changes to the documentation only[^2]

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

### Test Plan

1. Try out some of the newly added links on the docs site.

- [ ] Unit Tests
- [ ] End to end tests

### Release Notes

- Documentation: Added links to API reference in guides.
2023-07-06 14:01:11 +00:00
Lu Wilson
df5fce2a39
(1/2) [docs] Restore some missing changes (#1652)
This PR restores some changes that were lost during the docs move from
bublic to brivate.

This is part 1 of two PRs. The second one is
https://github.com/tldraw/brivate/pull/2124

### Change Type

- [x] `documentation` — Changes to the documentation only[^2]

[^1]: publishes a `patch` release, for devDependencies use `internal`
[^2]: will not publish a new version

### Release Notes

- None (Docs internals)
2023-06-26 16:22:48 +00:00
Renamed from docs/docs/usage.mdx (Browse further)