-
Notifications
You must be signed in to change notification settings - Fork 536
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
refactor(docs): Use file path links #23322
Conversation
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
1. [SharedMap](../data-structures/map), a map-like data structure for storing key/value pair data. | ||
2. [SharedString](../data-structures/string), a data structure for string data. | ||
1. [SharedMap](../data-structures/map.mdx), a map-like data structure for storing key/value pair data. | ||
2. [SharedString](../data-structures/string.md), a data structure for string data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this be .mdx?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nvm, i see that the string file is a .md. Wondering why its not mdx like the right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a few documents that are still .md
because they use our markdown-magic
tooling to embed contents from other Markdown docs elsewhere in the repo. That tool, unfortunately, doesn't work in .mdx
.
We have an item in the backlog to explore alternatives to markdown-magic
that would suit our needs here, but until then such documents have to remain .md
.
@@ -62,7 +61,7 @@ Although the value of a pair can be a complex object, the value of any given pai | |||
|
|||
## SharedString | |||
|
|||
The [SharedString](./string) DDS is used for unstructured text data that can be collaboratively edited. It is optimistic. | |||
The [SharedString](./string.md) DDS is used for unstructured text data that can be collaboratively edited. It is optimistic. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be .mdx?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nvm, i see that the string file is a .md. Wondering why its not mdx like the right?
In accordance with the updated guidance in our docs README.
AB#25895