Skip to content

[docs] Improve migration guides to link raw markdown format for AI #17210

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 8 commits into from
Apr 22, 2025

Conversation

cherniavskii
Copy link
Member

@cherniavskii cherniavskii commented Mar 31, 2025

As an experiment, I added raw .md migration guide files that are easier to consume by AI tools like Copilot or Cursor

@cherniavskii cherniavskii added the docs Improvements or additions to the documentation label Mar 31, 2025
@cherniavskii cherniavskii requested review from a team April 1, 2025 10:41
@cherniavskii cherniavskii marked this pull request as ready for review April 1, 2025 10:41
@bernardobelchior
Copy link
Member

As an experiment, I added raw .md migration guide files that are easier to consume by AI tools like Copilot of Cursor

There's also this llms.txt proposal. Could we use that with Cursor and, as a side-effect, expose it for other LLMs?

Just wondering 🤔

@cherniavskii
Copy link
Member Author

@bernardobelchior Yes, I'm aware of that. However, it will be a larger effort to adopt it for the MUI docs as a whole.
This PR is a low-hanging fruit. These .md files are much more friendly to AI code tools.

@alexfauquette
Copy link
Member

@cherniavskii Do you know if the markdown file needs to be hosted on the same domain name?

If not, we already have something nearly ready for all pages: the "Edit this page" button that links to the GitHub edit page. We could have a similar one leading to the GitHub raw page

image

@cherniavskii
Copy link
Member Author

Do you know if the markdown file needs to be hosted on the same domain name?

No, it doesn't.

we already have something nearly ready for all pages: the "Edit this page" button that links to the GitHub edit page.

Oh, I didn't think of it! Do you think we should prefer linking to GitHub instead?

@alexfauquette
Copy link
Member

Do you think we should prefer linking to GitHub instead?

I'm not familiar with those files for LLM. So I don't know what we should do. But I can see some points:

  1. The main advantage of github link is the implementation. Just modifying the footer component adds the link to all markdown pages (including the core and toolpad docs). Instead of adding pages, you modify the page layout
  2. The SEO: for Google, I don't know what is the impact of internal page with similar content. Coudl it be interpreted as duplicate? We should be careful to don't get those MD files indexed by Google search engine. At least with external links it's not an issue
  3. We would be blocked on further improvement. If at some point you want to replace the {{"demo": .... }} bloks by their code in the MD files, this would not be feasible with the GitHub links

@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 18, 2025

Related to mui/base-ui#1738.

@cherniavskii
Copy link
Member Author

@alexfauquette I updated the PR to link to the raw .md files on GitHub instead. Thanks for the idea!

@cherniavskii cherniavskii enabled auto-merge (squash) April 21, 2025 18:53
@cherniavskii cherniavskii merged commit c208ed0 into mui:master Apr 22, 2025
19 checks passed
@cherniavskii cherniavskii deleted the migration-guide-md-version branch April 22, 2025 09:57
bernardobelchior pushed a commit to bernardobelchior/mui-x that referenced this pull request Apr 22, 2025
@oliviertassinari oliviertassinari changed the title [docs] Serve migration guides in raw markdown format [docs] Improve migration guides to link raw markdown format for AI Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants