Roadmap to doctree v1.0

sourcegraph / doctree

First-class library documentation for every language (based on tree-sitter), with symbol search & more. Lightweight single binary, run locally or self-host. Surfaces usage examples via Sourcegraph.

https://doctree.org

Apache License 2.0

872 stars 25 forks source link

Roadmap to doctree v1.0 #27

Open slimsag opened 2 years ago

slimsag commented 2 years ago

State of doctree today: v0.1

We're working towards v0.2, and are only 8 weeks into development.

[x] Binary releases for every OS
[x] Docker images you can self-host
[x] Basic search navigation experience
Basic support for
- [x] Go (missing vars/consts/etc, only functions working today)
- [x] Python (missing vars/consts/etc, only functions working today)
- [x] Markdown (missing search integration, ability to link to headers)

Major milestones coming soon

[x] #18
[ ] #11
[x] #19
[x] #21
[ ] #15

Feedback on anything very welcome!

DaivikDave commented 2 years ago

Hey @slimsag, I would like to contribute to doctree,I have gone throught the codebase and have basic understanding of the components. Can I take any of the issues mentioned above on the server side? I can work on adding basic support for Go/Python but if it's taken, I can work on other issues as well!

slimsag commented 2 years ago

@DaivikDave I'd love that! Right now Go and Python indexers are pretty active, maybe you'd like to work on creating a new indexer for a new language, though? You can probably easily copy the Python one right now to get started - and see https://github.com/sourcegraph/doctree/issues/10 for some resources on how it all works.

A JS/TS one, Java one, etc. would be very cool. Or if you want to help in other places let me know. Also join the Discord :)

DaivikDave commented 2 years ago

@slimsag Thanks. I would to work on language support for javascript. I'll go through the language support issue to get started and join discord!