Product Thumbnail

MUI for VS Code

Ask questions to the MUI docs straight from VS Code

Open Source
Developer Tools
Artificial Intelligence

Chat with an AI expert on MUI without ever leaving VS Code. Simply type "@mui" into GitHub Copilot and get high-quality answers with references to the most up-to-date MUI documentation.

Top comment

Hey there! I'm Ayaan, and I accidentally became a software engineer. It wasn’t exactly in my life plan, but here we are! My coding journey started in a pretty roundabout way. I began as a UX designer at CAMP Systems International, where my main task was to make dashboards look pretty. At that point, I hadn’t written much code, besides messing around with Webflow to build websites. I knew just enough about HTML and CSS to be dangerous, but that was about it. A few years back, I started contracting with another company, doing the usual design work—pamphlets, websites, logos, you name it. But then, they threw me a curveball: "Hey, can you help us develop some UI components in React?" At this point, I hadn't done much programming, so my initial reaction was a mix of panic and "Are you sure you want me to do this?" But they were fans of my work and insisted I give it a shot. My Project The project had a straightforward tech stack: a dashboard built with MUI, React, and Redux. React was relatively easy to pick up because of its similarity to HTML, but MUI and Redux? They were brutal. Redux was a conceptual beast with its reducers, middleware, thunks, and whatnot. And MUI? It felt like every time I built something, I’d discover MUI already had a component for it. The sheer size of the library was overwhelming—until I stumbled upon my new best friend: Copilot. Copilot About a year ago—one year into my accidental software engineering career—a friend suggested I try GitHub Copilot. At first, it was magical. I’d ask it to write code, and It would just do it all for me. For a few days, I felt like the most productive person on the planet. But then the new-toy effect wore off, and I realized Copilot wasn’t perfect. For MUI, which had become my go-to library, it often used outdated documentation Context is Key It’s clear why Copilot struggles—it simply doesn't have the context to answer properly. There are solutions out there that try to tackle this issue. Products like Phind, SearchGPT, and Perplexity attempt to solve the problem by indexing the internet, doing retrieval using a vector database, and feeding that as context to the LLM. These solutions often perform better than a raw LLM, but they still have issues like outdated documentation and irrelevant context retrieval. I’d like to propose a slightly different approach. Instead of piecemealing together an image of a product based on internet queries, why not provide a quality knowledge repository to pull from? In this repository, documentation, GitHub issues, GitHub repositories, code examples, and more should be easily searchable. Here’s my best attempt at making that happen for MUI. MUI Copilot Extension As a prolific MUI user, I decided to create a VSCode Chat participant for GitHub Copilot. This participant has indexed MUI's documentation and example repositories, and it can be used directly in VSCode with a GitHub Copilot subscription. I’m still figuring out how to allow everyone to contribute to this, but I’m excited for people to try out this RAG system. Hope you enjoy!

Comment highlights

It's innovative, in my opinion, to have MUI documentation easily accessed within VS Code. It is really convenient to receive replies and references without leaving the editor. This tool looks like it could save a lot of time

Congratulations on launching the extension. It sounds like an excellent method to increase the efficiency and enjoyment of working with MUI. Great job on making something so beneficial for developers, but some further guidance or onboarding may help individuals who are unfamiliar with MUI or GitHub Copilot get started more easily.

I think integrating some interactive tutorials or code snippets directly into the chat could be a great addition. For me, seeing practical examples as I ask questions would make the learning process even smoother. 😊

Chatting with MUI documentation via GitHub Copilot saves time, and the upcoming feedback and search features in the editor will boost productivity.

@ayaangill Congratulation on your product launch 🚀. I admire the design patterns of MUI, and I believe my background in User centered design aligns well with your team’s needs. Will you be needing a Product Designer?

Big congrats on launching this tool! It’s going to save so much time for devs working with MUI.

This is such a smart integration! Wishing you all the best with the launch, it’s going to be super helpful.

I love seeing tools that make developers' lives easier. Congrats on the launch, this looks like a effective tool!

It's a clever approach to streamline the development process. I really appreciate the effort you’ve put into making it easier to access MUI information directly within VS Code.

Ability to get instant answers from the documentation by simply typing `@mui` is a awesome. It’s great to see such seamless integration that keeps developers focused on their work without constantly switching contexts.