{"id":13483907,"url":"https://github.com/adamcooke/documentation","last_synced_at":"2025-03-27T15:30:44.025Z","repository":{"id":18543816,"uuid":"21744913","full_name":"adamcooke/documentation","owner":"adamcooke","description":"A Rails engine to provide the ability to add documentation to a Rails application","archived":true,"fork":false,"pushed_at":"2023-01-20T07:25:12.000Z","size":185,"stargazers_count":214,"open_issues_count":22,"forks_count":38,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-25T14:58:00.322Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamcooke.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-11T17:19:52.000Z","updated_at":"2024-08-14T15:28:54.000Z","dependencies_parsed_at":"2023-02-12T00:31:31.462Z","dependency_job_id":null,"html_url":"https://github.com/adamcooke/documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcooke%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcooke%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcooke%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcooke%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamcooke","download_url":"https://codeload.github.com/adamcooke/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245871696,"owners_count":20686250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T17:01:16.742Z","updated_at":"2025-03-27T15:30:43.352Z","avatar_url":"https://github.com/adamcooke.png","language":"Ruby","readme":"# Documentation\n\nDocumentation is a Rails engine which provides a complete system for managing a set of hierarchical documentation. Once installed in an application, you'll have a complete user interface for viewing as well as editing a set of markdown pages.\n\n![Screenshot](http://s.adamcooke.io/14/VGaMe.png)\n\n## Installation\n\nTo get started, you need to add Documentation to your Gemfile and run `bundle`.\n\n```ruby\ngem 'documentation', '~\u003e 1.0.0'\n```\n\n[![Gem Version](https://badge.fury.io/rb/documentation.svg)](http://badge.fury.io/rb/documentation)\n\nNext, you'll need to run the setup generator which will add a route to your `config/routes.rb` file for the Documentation interface.\n\n```\nbundle exec rails generate documentation:setup\n```\n\nYou now need to populate your database schema and load the initial documentation pages.\n\n```\nbundle exec rake db:migrate documentation:install_guides\n```\n\nOnce this is done, you can go ahead and start up your Rails application and browse to `/docs` to view your documentation system.\n","funding_links":[],"categories":["Ruby","Documentation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamcooke%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamcooke%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamcooke%2Fdocumentation/lists"}