Commit graph

6 commits

Author SHA1 Message Date
Lu Wilson
2403577da0
(2/2) [docs] Fix links to API. (#1654)
This PR fixes some links to the API in the docs.
It's part 2 of two PRs related to simplifying the paths of our API
reference.
This first one is https://github.com/tldraw/brivate/pull/2128

### 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. On the docs site...
2. Go to the Editor page...
3. Click on the links to the Editor API reference.
4. Make sure they take you to the right place.

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

### Release Notes

- Documentation: Simplified links to the API reference.
2023-06-27 08:34:12 +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
Lu Wilson
02c4ed48ef
[docs] Remove embeds page (#1653)
This PR removes the skeleton Embeds page.

While we're here, do we also want to remove the skeleton Persistence
page (would it fit somewhere else? or nah?)

### 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. On the docs site...
2. Make sure that there's no 'Embeds' page in the menu.

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

### Release Notes

- Documentation: Removed unused Embeds page.
2023-06-26 16:22:29 +00:00
Lu Wilson
b3029e3fd3
[docs] Add table of contents to Editor page (#1642)
This PR adds a table of contents to the Editor docs page.

The Editor page is quite long, with different sections. I think that
some contents at the top will make it slightly more approachable &
usable for now.

### 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

- Documentation: Added a table of contents to the Editor page.

---------

Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2023-06-24 08:23:02 +00:00
Steve Ruiz
44387eb363
untrack generated files (#1646)
This PR untracks generated docs files. It does some minor repo cleanup.

### Change Type

- [x] `internal`
2023-06-24 08:22:42 +00:00
Steve Ruiz
096df3209b
[1/2] Move docs to brivate (#1640)
This PR moves the docs site to the private repo while keeping the docs
content on the public repo.

### Change Type

- [x] `documentation`
2023-06-23 14:23:14 +00:00