ruby-syntax-tree / syntax_tree

Interact with the Ruby syntax tree
https://ruby-syntax-tree.github.io/syntax_tree/
MIT License
563 stars 54 forks source link

Use `rubydoc.info` for API documentation #415

Open faraazahmad opened 10 months ago

faraazahmad commented 10 months ago

The current documentation for syntax_tree uses RDoc. However, it is not the most user-friendly docs tool out there, as you have also stated in #279. I propose syntax_tree use rubydoc.info for its API documentation going forward, and the syntax_tree website can link to it, white it transitions into a proper guide with tutorials and such.

https://rubydoc.info/gems/syntax_tree