Skip to content

[Feature request] Pull rake tasks into documentation #5675

Description

@ChrisBAshton

A number of our repos have well-documented rake tasks of the form:

desc "Long description"
task :rake_task_name, %i[arg] => :environment |_task, arg|
  # do something
end

Here is an example.

These rake tasks are not indexed in the Developer Docs at all, unless reference to them has been duplicated in a repo's *.md documentation or on a dedicated Developer Docs page.

Given documentation tends to fall out of sync with code quite easily, it would be better to pull the actual real rake task descriptions into the Developer Docs, automatically. Then when we search "reslug person", it'll bring up the rake task rather than zero results.

Activity

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions