fix: update paths to match api

seamapi / docs

Welcome to the Seam Docs.

https://docs.seam.co

4 stars 10 forks source link

fix: update paths to match api #313

Closed mikewuu closed 3 weeks ago

mikewuu commented 3 weeks ago

closes #304

Notable things

Left docs/api-clients/overview.md unchanged since it is stale, and very different to things on main
Fixed missing directories in gitbook redirect (introduced when handling #303)

razor-x commented 3 weeks ago

@mikewuu I can't see any obvious issues (obviously there are a lot of changes to check), but a few URLs are still not working. Most seem ok!

Unfortunately I don't see anyway around a manual check: we need to verify every page resolves as expected by clicking though every page on the left nav under the api ref and verifying the URL is what we expect.

I started clicking though and noticed these two pages have incorrect routes

/api/access-codes/get-an-access-code
/api/access-codes/list-1

razor-x commented 3 weeks ago

Went though all the links and these are the ones that are still mismatched

[ ] /api/workspaces/reset-workspace
[ ] /api/connected_accounts/update-a-connected-account
[ ] /api/devices/device-provider-metadata
- This is not a reference page, so we have to leave it for now. But the content needs to be moved later.
[ ] /api/devices/list-unmanaged-devices
[ ] /api/devices/get-an-unmanaged-device
[x] /api/devices/update-1
[ ] /api/devices/delete-a-device
[ ] /api/access-codes
[ ] /api/access-codes/get-an-access-code
[x] /api/access-codes/list-1
[x] /api/access-codes/delete-1
[ ] /api/acs/entrances/list-entrances
[x] /api/acs/access-groups
[ ] /api/thermostats/list-thermostats
[ ] /api/thermostats/get-thermostat
[ ] /api/thermostats/climate-setting-schedules (being removed anyway, but everything under this path is incorrect)

razor-x commented 3 weeks ago

@mikewuu you can follow this GitBook lisk to test it (preview env)

mikewuu commented 3 weeks ago

@razor-x @dawnho , can I please get access to gitbook?

CleanShot 2024-08-23 at 08 52 27@2x

razor-x commented 3 weeks ago

@mikewuu I'm going to merge this one. Then we can update beta from main and open a draft PR to main to get feedback on the generated pages.

We can use that PR to test the link issues and make sure we fix them before release. We should still open new PRs against beta while that is open.

razor-x commented 2 weeks ago

@mikewuu Merging https://github.com/seamapi/docs/pull/317 fixed these (I updated the list):

[x] /api/access-codes/list-1
[x] /api/access-codes/delete-1
[x] /api/acs/access-groups

but not the others.