Skip to content
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

docs: fix links url #691

Merged
merged 2 commits into from
Mar 15, 2023
Merged

docs: fix links url #691

merged 2 commits into from
Mar 15, 2023

Conversation

devagja
Copy link
Contributor

@devagja devagja commented Mar 6, 2023

@codesandbox-ci
Copy link

codesandbox-ci bot commented Mar 6, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit fc183d2:

Sandbox Source
React Configuration
React Typescript Configuration
React Browserify Configuration
React Snowpack Configuration
React Parcel Configuration

@vercel
Copy link

vercel bot commented Mar 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
valtio ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 14, 2023 at 3:01PM (UTC)

@dai-shi dai-shi linked an issue Mar 6, 2023 that may be closed by this pull request
Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch.
We want to be able to browse docs in github.
Can you make all links relative paths?

@@ -59,7 +59,7 @@ authState.user.name = 'Nina'

#### Promises in proxies

See [`async`](/docs/advanced/async) for more details.
See [`async`](/docs/guides/async) for more details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be

Suggested change
See [`async`](/docs/guides/async) for more details.
See [`async`](../../guides/async.mdx) for more details.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed, Thx for all!

@dai-shi
Copy link
Member

dai-shi commented Mar 7, 2023

Hmm, adding extension broke the website.
@roguesherlock Is it possible to remove .mdx extension when deploying website?

@roguesherlock
Copy link
Collaborator

@dai-shi Currently the renderer we use to parse the markdown doesn't support it but It should be possible to add a plugin to do that for us.

@dai-shi
Copy link
Member

dai-shi commented Mar 8, 2023

@dai-shi Currently the renderer we use to parse the markdown doesn't support it but It should be possible to add a plugin to do that for us.

Oh, that's unfortunate. I wonder if anyone would be interested in supporting it.
Otherwise, we would need to remove the extension for now...

@devagja
Copy link
Contributor Author

devagja commented Mar 8, 2023

I am going to change the routes as at the beginning.
I can research how to fix it but if anyone else can investigate, I'd appreciate it.

I leave here the link with the commit of the relative paths with mdx ->
https://github.com/devagja/valtio/commit/0b6323f0e6c66fe35eb90cb1750d85683be9f39b

@dai-shi
Copy link
Member

dai-shi commented Mar 8, 2023

I am going to change the routes as at the beginning.

If it's about a workaround, can it be relative paths without .mdx? It won't fix, but people can add the extension when 404.

@devagja
Copy link
Contributor Author

devagja commented Mar 14, 2023

If it's about a workaround, can it be relative paths without .mdx? It won't fix, but people can add the extension when 404.

sorry for the lapse of time,
I just added the relative paths without the .mdx

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks!

@dai-shi dai-shi merged commit 7fe26c2 into pmndrs:main Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS]: wrong API url links
3 participants