Skip to content

docs via repo #37

Open
Open

Description

@davidmann4

http://yardoc.org/ ?

@pferdefleisch what's a good tool to document rails apps? or should I just add a docs/ folder and put *.MD files into it?

Activity

  1. mraaroncruz commented on Feb 11, 2017

    @mraaroncruz
    Contributor

    I believe yard is better for code documentation whereas .md files would be fine for project documentation. I'm not aware of any tools to make it html but since you're probably married to a version control hosting platform, linking to .md files sounds the nicest. And easy enough to convert should you start to care about people viewing them locally or if you move away from a github(lab).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions