ruby-grape / ruby-grape/grape-entity

Setup YardDoc

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Ruby
Stars
729
Forks
154
PR merge metrics
No merged PRs in 30d

Description

We had this in the Rakefile

#
# TODO: setup a place for documentation and then get this going again.
#
# begin
#   require 'yard'
#   DOC_FILES = ['lib/**/*.rb', 'README.markdown']
#   
#   YARD::Rake::YardocTask.new(:doc) do |t|
#     t.files   = DOC_FILES
#   end
#   
#   namespace :doc do
#     YARD::Rake::YardocTask.new(:pages) do |t|
#       t.files   = DOC_FILES
#       t.options = ['-o', '../grape.doc']
#     end
#     
#     namespace :pages do
#       desc 'Generate and publish YARD docs to GitHub pages.'
#       task :publish => ['doc:pages'] do
#         Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
#           system("git add .")
#           system("git add -u")
#           system("git commit -m 'Generating docs for version #{version}.'")
#           system("git push origin gh-pages")
#         end
#       end
#     end
#   end
# rescue LoadError
#   puts "You need to install YARD."
# end

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the commented YARD setup in the Rakefile, including DOC_FILES for lib/**/*.rb and README.markdown and the doc:pages publishing tasks. Check how the repository currently handles documentation, then restore a working generation and GitHub Pages publishing flow; done means the documented tasks run successfully and produce the expected docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.