Last week we shipped some amazing improvements, bug fixes & a new feature, let's dive in!
Community Contributors ✨
We wanted to give a shoutout to our first contributors who shipped some great work on the Open-Source repository:
- FotieMConstant - Fixed a couple typos :)
- ATREAY - added optional level prop to section component
- danp - added issue templates
- ATREAY - handle both direct and proxied responses
Stoked to see these all running in production and bettering the Scalar API References ✨
Scalar AI Content Writer
We were at the a16z JS Hackathon hosted by clerk.com where we had the idea to build an AI Content Writer directly inside of the Swagger Editor. Give us a few headings and we fill in the rest, giving you a great starting point for your documentation.
A little bit about how it works: We vectorize all of the content in the Swagger/OpenAPI Spec files, then vectorize the headings and give relevant context into the round robin LLM selector we have (we run a few different models and see which performs the best). Then stream the output into our markdown renderer. ✨
Check it out here here
Download Swagger/OpenAPI Spec URL
Now you can download your Spec directly on the page!
A highly requested improvement from our community.
Fixes & Improvements
Most of our week was spent shipping lots of incremental fixes!
- fix markdown collisions + prefix the card name
- fix: add deprecated footerBelowSidebar again (use configuration object instead)
- feat: add download spec button
- refactor: improve the data flow between the reference and the swagger editor
- refactor: move json helpers to separate files
- fix typography on editor headings
- clean up getting started page & move auth card down
- style: use ellipsis for empty strings
- fix: active state for operations with multiple tags
- externalize all @scalar/use-codemirror deps
- fix: make inputs more consistent
- fix: issue where browser froze with JSON being passed into codemirror body
- fix: add target blank to markdown links
- fix: don't overwrite the URL on small screens
- Refactor and simplify API references layout
- fix: make the sidebar work with tags without operations
- feat: example objects in arrays for example responses
- feat: use min value as the default for generated example responses
- use min value as the default for numbers
- Refactor API References Styles
- fix: preload ssl generation for custom domains
- feat: messaging on publish action
- fix: header links breaking empty state in editor
- fix: update links on default footer
- fix: only add default content if sidebar item length is 1
- fix: use SVG for fallback favicon
- fix: add missing sitemap to [scalar.com](http://scalar.com/)
- fix: add missing sitemap for swagger editor
- fix: guide not being active in document header
- feat: add copy to clipboard for headings in guides
- feat: multiple guides and references
Join us:
Marc
CEO & Co-Founder, Scalar