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

refactor(docs): Use file path links #23322

Merged
merged 3 commits into from
Dec 13, 2024
Merged

Conversation

Josmithr
Copy link
Contributor

@Josmithr Josmithr commented Dec 13, 2024

In accordance with the updated guidance in our docs README.

AB#25895

@Josmithr Josmithr requested a review from a team December 13, 2024 00:13
@github-actions github-actions bot added area: website base: main PRs targeted against main branch labels Dec 13, 2024
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170006 links
    1595 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors


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.
Copy link
Contributor

@seanimam seanimam Dec 13, 2024

Choose a reason for hiding this comment

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

should this be .mdx?

Copy link
Contributor

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?

Copy link
Contributor Author

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be .mdx?

Copy link
Contributor

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?

@Josmithr Josmithr enabled auto-merge (squash) December 13, 2024 18:04
@Josmithr Josmithr merged commit a976a85 into microsoft:main Dec 13, 2024
45 checks passed
@Josmithr Josmithr deleted the docs/update-links branch December 13, 2024 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: website base: main PRs targeted against main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants