Roadmap to doctree v1.0

[slimsag]

State of doctree today: v0.1

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

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

Major milestones coming soon

• add a "follow-as-you-go" sidebar navigation on docs pages #18
• make it possible to link to sections on the page #11
• should work nicely for more than just code/libraries (generic markdown docs) #19
• auto-indexing functionality #21
• Automagic real-world usage examples, code intelligence (opt-in sourcegraph integration) #15

Feedback on anything very welcome!

[DaivikDave]

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]

@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 #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]

@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!