Hi Everyone, I'm Tim, creator of Omniref. Thanks for taking a look!
This is a brand-new product, based on feedback from the code documentation
site we launched on ProductHunt last year. We got a great response for
that, and one of the most-requested features from that launch was to allow
people to annotate their own code. This is the result of nearly a year of
work to make that possible.
The core feature of Omniref is the ability to attach markdown-enabled notes
to any line(s), in any source file, in a GitHub repository. Once you set a
note, it stays "stuck" to those lines, for as long as they're in the
repository. Even if lines move around or change, the notes stay right where
you put them. Early users saw potential for this as a code review tool, so
we built that right in -- you review diffs on a pull request, and those
reviews stay stuck to the code, even after the review has been closed and
the code has been merged. Code reviews become documentation for your
software!
This works seamlessly because the tool computes a complete revision history
for every line in your repository. This also lets you easily do things that
other tools can't, like navigate forward and backward in time for any file,
with one click. It's kind of like git-blame, but way more powerful.
The plan is to create tools that build on this platform -- things like
exception tracking, to-dos, and more -- but I'd love to hear new ideas and
suggestions from you. Let me know if you have any questions!
Hi Tim, previously Omniref only supported JS and Ruby. Are other languages supported now? Also, are there any plans to integrate with non-GitHub repositories (like GitLab)?
@_mattam Hi Matthew. One of the major changes over the "old" Omniref is that this is language agnostic. It supports every (non binary) file type.
Right now I'm focusing on improving the use-cases and tools -- code review, adding an API, etc. But it really only depends on git, so extending to support other git hosts is definitely on the roadmap. I can be convinced to move that up if there's enough interest!
Omniref