sureDoc

• 

  Logo

• 

  Demo

• 

Inspiration

The art of simplification by not reinventing the wheel.

What it does

sureDoc steam lines your development experience by providing documentation for packages used, in line, when you hover over the class name.

For example when you hover "pandas.DataFrame", sureDoc retrieves the exact documentation that is the most up-to-date from the official pandas doc page.

Saving developer time by elimination of context switching from browser (documentation) to fully integrated IDE workflow. Reducing the cognitive load and decision fatigue for developers to immerse into their work.

Reduces a 5 step process into a single hover.

How we built it

We built sureDoc as a VS Code extension. First we detect the portion of text you are hovering over, if it is a externally imported library then we access the official documentation website. Cheerio then scrapes this data from the web and this is passed to claude which locates the specific portion of the documentation formats the data for display.

Challenges we ran into

Figuring out how integrate within VS Code hover functionality. Support for multiple python libraries: pandas, numpy, pytorch, mediapipe etc.

Accomplishments that we're proud of

Fully functional live documentation extension. Provides the most recent documentation to the user. Keeping up to the VS Code user experience.

What we learned

We learnt to build a VS Code extension. The simplest solution is the best solution.

What's next for sureDoc

Further expansion of supported libraries. Further expansion of programming languages. Publication into VS Code marketplace. Making the project open-source so other developers can contribute.

Built With

• python
• typescript