Skip to content

docs: move api and cli docs routes to reference/ #14241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Aug 13, 2024
Merged

Conversation

matifali
Copy link
Member

@matifali matifali commented Aug 12, 2024

As part of #13434, this PR moves CLI and API docs under reference.

This will help reduce the size of #14182.

we need to create redirects from docs/[cli,api] to docs/reference/[cli,api]

Docs link check is passing so it should be fine to merge.

@matifali matifali requested a review from stirby August 12, 2024 15:02
@matifali matifali added the docs Area: coder.com/docs label Aug 12, 2024
@kylecarbs
Copy link
Member

Do the routes need to be nested like that? The redirects feel unnecessary.

@matifali matifali changed the title docs: move api and cli docs under reference docs: move api and cli docs to reference Aug 12, 2024
@matifali
Copy link
Member Author

The redirects feel unnecessary.

@kylecarbs Aren't redirects required for any old links to work? in case someone is using those links in any internal docs?

Do the routes need to be nested like that?

I fixed the manifest. Routes are now nested under Reference.

@matifali matifali changed the title docs: move api and cli docs to reference docs: move api and cli docs routes to reference/ Aug 13, 2024
Copy link

alwaysmeticulous bot commented Aug 13, 2024

✅ Meticulous spotted zero visual differences across 1354 screens tested: view results.

Expected differences? Click here. Last updated for commit 4f098d0. This comment will update as new commits are pushed.

@matifali matifali force-pushed the matifali/move-refrences branch from 5978a06 to a0efc99 Compare August 13, 2024 14:52
@kylecarbs
Copy link
Member

I can make the redirect on coder.com whenever this is good to merge!

@matifali matifali requested a review from kylecarbs August 13, 2024 14:59
stirby

This comment was marked as resolved.

@stirby
Copy link
Collaborator

stirby commented Aug 13, 2024

Nice work 👍

@matifali matifali merged commit 48f29a1 into main Aug 13, 2024
35 of 36 checks passed
@matifali matifali deleted the matifali/move-refrences branch August 13, 2024 15:39
@github-actions github-actions bot locked and limited conversation to collaborators Aug 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants