Stephen has worked with most of Sourcegraph's largest customers, and enjoys solving the most critical and technically challenging issues users face in our effort to bring world-class developer tools to everyone. Stephen Gutekanst is one of Sourcegraph's earliest engineers, and has authored many parts of Sourcegraph including the src CLI, m onitoring architecture, managed instances, and editor extensions to name a few. We've also made it possible to submit feedback on the API docs pages themselves,and you can also send feedback to us via Twitter Use the feedback widget on API docs pages, or directly email feedback to us! About the author In fact, we're making it possible to email feedback directly to the lead engineer (that's me) eager to hear what you think! The Go LSIF indexer chooses to display URL hashes in a way that makes sense specifically for Go, with a `Receiver.Method` format Soon it will be possible to search and filter using Sourcegraph's deep semantic understanding of type information Direct feedbackĪPI docs is still very early in development, so we're making it as easy as possible to give feedback. Sourcegraph merely renders it, indexes it, and adds a nice navigation experience. One way we've enabled this is by allowing LSIF language indexers to emit data in the way they see fit. We're paying attention to the small details, and really tailoring API docs to each language.Īt Sourcegraph, we use primarily Go and TypeScript-so we're starting by building an experience that Go developers will love, then we'll expand to more languages and build an experience that is really tailored to, and makes sense in the context of, the individual language.
#PEEK COM API HOW TO#
Use the API docs button on any repository page to access API docs Once you click it, you'll be greeted with information about how to get started Understands the types of symbols, and uses iconography to communicateĪPI docs is built on code intelligence data, so it has a deep semantic understanding of symbols, their type information, whether they're deprecated, a function, variable, interface, etc., and the UI now communicates this information using icons: A structured tree of symbols with type information to navigate a Go package's documentation A deep understanding of code The most important announcement here is that API docs is now an on-by-default experiment for everyone! You can begin trying it out on as well as your own Sourcegraph instance.
Want to try it out on your own Go repositories? Tweet with your GitHub repository name and we'll set it up for you, or follow our documentation. Today, it's still in its very early stages-and only a few months into development. Giving an amazing navigation and search experience.Providing a single tool that works across all code, using LSIF data to provide an experience tailored towards your languages of choice.
At Sourcegraph, we have a small team working hard on a new experimental feature: API docs.
0 kommentar(er)
