Skip to content

0tt049/murdoc

Repository files navigation

Logo

Murdoc

A new and improved way of looking for Ruby's documentation

MIT License Site Status Commit per week Last commit ISSUES Contributors

Send us some love

obligatory screenshot

screenshot

Key Features

  • Tree View - Browse through classes.
    • See who is who inside Ruby.
    • Search for classes.
    • Finally undestand the Ruby Object Model.
  • Class Ancestry Path
    • See from which Classes and Modules does the Class of interest get it's methods from!
    • And as a bonus, you get to use the Ancestry Path as a filter for the method lists at the right panel.
  • Method List
    • This is where you get to enjoy that juicy, unlimited list of Methods. Each one with it's own unique super-power.
  • Documentation TV
    • Choose a Class and you get it's doc, choose a Method and yes... more docs. Pages and pages of them.
    • And if you can't find the doc you're looking for... please, don't be shy, tell us everything about it at our Issues section, and we'll try our best get those delicious docs for you!

Tech Stack

Client: Stimulus.js, Bootstrap

Server: Ruby on Rails

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Authors

Acknowledgements

Last words!

Murdoc was sketched, coded, and deployed in 10 days as our final project at Le Wagon bootcamp. And it is now available for the Ruby community to break it, test it, and make it better.

About

A new and improved way of looking for Ruby's documentation

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published