asm-helpful/helpful-web
Help shouldn't hurt – Read the documentation
This page shows an evaluation of the documentation of asm-helpful/helpful-web.
Each class, module, method, etc. is given a grade based on how complete the docs are.
The bar above shows the distribution of these grades.
| Seems really good | ||
|---|---|---|
|
A
|
ConversationSummarizer |
|
|
A
|
ConversationsArchive |
|
|
A
|
ConversationsInbox |
|
|
A
|
MessageAuthor |
|
|
A
|
Nicknamer |
|
| Show 31 more ... | ||
|
A
|
Concierge |
|
|
A
|
Webhook |
|
|
A
|
Account#get_update_from_chargify! |
|
|
A
|
Conversation.match_mailbox! |
|
|
A
|
Account.match_mailbox! |
|
|
A
|
AvatarHelper#avatar |
|
|
A
|
ConversationsArchive#most_recent_conversations |
|
|
A
|
ConversationsArchive#archived_conversations |
|
|
A
|
ConversationsSearch#search_conversations |
|
|
A
|
MessageAuthor#person_with_updated_name |
|
|
A
|
ConversationsInbox#conversations_queue |
|
|
A
|
ConversationsInbox#open_conversations |
|
|
A
|
ConversationsSearch#search_messages |
|
|
A
|
ConversationsArchive#conversations |
|
|
A
|
ConversationsInbox#conversations |
|
|
A
|
Concierge#find_conversation |
|
|
A
|
Conversation#mailbox_email |
|
|
A
|
ActiveModel::HalSerializer |
|
|
A
|
Account#mailbox_email |
|
|
A
|
Person#initials |
|
|
A
|
ActiveModel::HalArraySerializer.embedded_resource_name= |
|
|
A
|
ActiveModel::HalSerializer#serializable_hash |
|
|
A
|
ActiveModel::Serializer::HalLinkUtils#links |
|
|
A
|
Oauth::ApplicationsController#create |
|
|
A
|
AttachmentUploader#store_dir |
|
|
A
|
Account#chargify_portal_url |
|
|
A
|
BillingsController#webhook |
|
|
A
|
Conversation.match_mailbox |
|
|
A
|
BillingsController#return |
|
|
A
|
Account.match_mailbox |
|
|
A
|
ActiveModel |
|
| Proper documentation present | ||
|---|---|---|
|
B
|
ApplicationController#authorize! |
|
|
B
|
MessageAuthor#person |
|
|
B
|
MessageAuthor#compose_message |
|
|
B
|
MessageMailer#created |
|
|
B
|
ActiveModel::HalArraySerializer.embedded_resource_name |
|
| Show 4 more ... | ||
|
B
|
ApplicationController#after_sign_in_path_for |
|
|
B
|
ConversationsInbox#previous_conversation |
|
|
B
|
ConversationsInbox#next_conversation |
|
|
B
|
Webhooks::MailgunController#parse_identifiers |
|
| Needs work | ||
|---|---|---|
|
C
|
Account#billing_plan_slug= |
|
| Undocumented | ||
|---|---|---|
|
U
|
ActiveModel::HalSerializer#include_associations! |
|
|
U
|
Users::InvitationsController#find_account! |
|
|
U
|
CannedResponsesController#find_account! |
|
|
U
|
TextcompletesController#find_account! |
|
|
U
|
ConversationManager#respond_later! |
|
| Show 286 more ... | ||
|
U
|
Mailgun::DeliveryMethod#deliver! |
|
|
U
|
ElasticsearchMessageIndexWorker |
|
|
U
|
ConversationManager#unarchive! |
|
|
U
|
UsersController#find_account! |
|
|
U
|
ConversationManager#archive! |
|
|
U
|
Conversation#respond_later! |
|
|
U
|
IncomingMessagesController |
|
|
U
|
CannedResponsesController |
|
|
U
|
ConversationsController |
|
|
U
|
Conversation#unarchive! |
|
|
U
|
MostRecentMessageHelper |
|
|
U
|
TextcompletesController |
|
|
U
|
ConversationSerializer |
|
|
U
|
TimestampedSerializer |
|
|
U
|
ApplicationController |
|
|
U
|
Conversation#archive! |
|
|
U
|
InvitationsController |
|
|
U
|
ConversationsMethods |
|
|
U
|
AttachmentSerializer |
|
|
U
|
ConversationManager |
|
|
U
|
DashboardController |
|
|
U
|
ConversationsSearch |
|
|
U
|
AccountsController |
|
|
U
|
ConversationStream |
|
|
U
|
AttachmentUploader |
|
|
U
|
MessagesController |
|
|
U
|
ConversationHelper |
|
|
U
|
BillingsController |
|
|
U
|
Account#subscribe! |
|
|
U
|
TextcompleteSearch |
|
|
U
|
Account#add_owner! |
|
|
U
|
MessageSerializer |
|
|
U
|
WebhookSerializer |
|
|
U
|
AccountReadPolicy |
|
|
U
|
Webhook#dispatch! |
|
|
U
|
UsersController |
|
|
U
|
PagesController |
|
|
U
|
MarkdownHelper |
|
|
U
|
NicknameHelper |
|
|
U
|
AccountsHelper |
|
|
U
|
BillingsHelper |
|
|
U
|
MessageMailman |
|
|
U
|
TagsController |
|
|
U
|
BaseSerializer |
|
|
U
|
SummaryHelper |
|
|
U
|
MessageMailer |
|
|
U
|
ApiController |
|
|
U
|
WebhookWorker |
|
|
U
|
Conversation |
|
|
U
|
AvatarHelper |
|
|
U
|
BillingPlan |
|
|
U
|
Chargify |
|
|
U
|
Account |
|
|
U
|
Message |
|
|
U
|
Person |
|
|
U
|
Policy |
|
|
U
|
Api::MessagesController#authorize_account_read! |
|
|
U
|
Api::MessagesController#find_conversation! |
|
|
U
|
Api::ConversationsController#find_account! |
|
|
U
|
Api::PeopleController#find_account! |
|
|
U
|
ConversationStream#each |
|
|
U
|
Membership |
|
|
U
|
#tweet_sized_snippet_from_first_message:: … :: |
|
|
U
|
AttachmentUploader#save_content_type_and_size_in_model |
|
|
U
|
ActiveModel::HalArraySerializer#embedded_resource_name |
|
|
U
|
MostRecentMessageHelper#most_recent_message_class |
|
|
U
|
CannedResponsesController#canned_response_params |
|
|
U
|
Chargify.subscription_id_from_customer_reference |
|
|
U
|
ActiveModel::HalArraySerializer#serialize_object |
|
|
U
|
ConversationsMethods#preloaded_conversations |
|
|
U
|
TextcompleteSearch#matching_canned_responses |
|
|
U
|
ConversationManager#create_assignment_event |
|
|
U
|
ConversationsMethods#account_conversations |
|
|
U
|
ElasticsearchMessageIndexWorker#perform |
|
|
U
|
TextcompleteSearch#matching_assignments |
|
|
U
|
ConversationManager#update_conversation |
|
|
U
|
Message#enqueue_to_update_search_index |
|
|
U
|
ActiveModel::Serializer::HalLinkUtils |
|
|
U
|
AvatarHelper#avatar_style_constraints |
|
|
U
|
ConversationSummarizer#first_message |
|
|
U
|
ConversationStream#assignment_events |
|
|
U
|
ConversationSummarizer#conversation= |
|
|
U
|
Oauth::ApplicationsController#index |
|
|
U
|
ConversationStream#subsequent_items |
|
|
U
|
TextcompleteSearch#canned_responses |
|
|
U
|
BillingsHelper#chargify_signup_link |
|
|
U
|
Api::ConversationsController#create |
|
|
U
|
Users::InvitationsController#create |
|
|
U
|
ConversationSummarizer#conversation |
|
|
U
|
Users::InvitationsController#update |
|
|
U
|
ConversationSerializer#account_slug |
|
|
U
|
Api::ConversationsController#index |
|
|
U
|
Mailgun::DeliveryMethod#initialize |
|
|
U
|
Conversation#notify_account_people |
|
|
U
|
Message#trigger_pusher_new_message |
|
|
U
|
Webhooks::MailgunController#create |
|
|
U
|
Mailgun::DeliveryMethod#settings= |
|
|
U
|
CannedResponsesController#destroy |
|
|
U
|
Account#unhide_paid_conversations |
|
|
U
|
ConversationManager#lookup_action |
|
|
U
|
Api::ConversationsController#show |
|
|
U
|
ConversationSummarizer#initialize |
|
|
U
|
IncomingMessagesController#create |
|
|
U
|
ConversationManager#conversation= |
|
|
U
|
Api::AttachmentsController#create |
|
|
U
|
CannedResponsesController#update |
|
|
U
|
CannedResponsesController#create |
|
|
U
|
Mailgun::DeliveryMethod#settings |
|
|
U
|
Mailgun::DeliveryMethod#api_host |
|
|
U
|
MessageAuthor#email_display_name |
|
|
U
|
TextcompleteSearch#cleaned_query |
|
|
U
|
AccountsController#configuration |
|
|
U
|
TextcompleteSearch#matching_tags |
|
|
U
|
Api::AttachmentsController#index |
|
|
U
|
ConversationManager#conversation |
|
|
U
|
ConversationStream#conversation= |
|
|
U
|
ConversationsController#archived |
|
|
U
|
ActiveModel::HalArraySerializer |
|
|
U
|
Api::AttachmentsController#show |
|
|
U
|
CannedResponsesController#index |
|
|
U
|
ConversationStream#stream_items |
|
|
U
|
ConversationManager#take_action |
|
|
U
|
Mailgun::DeliveryMethod#api_key |
|
|
U
|
ConversationStream#conversation |
|
|
U
|
ConversationsSearch#clean_query |
|
|
U
|
ConversationsArchive#initialize |
|
|
U
|
Api::MessagesController#create |
|
|
U
|
ConversationHelper#flash_class |
|
|
U
|
ConversationManager#initialize |
|
|
U
|
TextcompleteSearch#assignments |
|
|
U
|
ConversationsController#update |
|
|
U
|
ConversationsController#search |
|
|
U
|
ConversationsInbox#queue_index |
|
|
U
|
TextcompleteSearch#query_regex |
|
|
U
|
CannedResponsesController#show |
|
|
U
|
CannedResponsesController#edit |
|
|
U
|
Api::AccountsController#update |
|
|
U
|
MessageMailman#deliver_to_each |
|
|
U
|
ConversationSummarizer#summary |
|
|
U
|
ConversationStream#initialize |
|
|
U
|
Api::AccountsController#index |
|
|
U
|
Oauth::ApplicationsController |
|
|
U
|
UsersController#person_params |
|
|
U
|
TextcompleteSearch#initialize |
|
|
U
|
ConversationsController#inbox |
|
|
U
|
TextcompleteSearch#query_type |
|
|
U
|
CannedResponsesController#new |
|
|
U
|
TextcompletesController#index |
|
|
U
|
Api::MessagesController#index |
|
|
U
|
Conversation#last_activity_at |
|
|
U
|
ConversationsInbox#initialize |
|
|
U
|
TimestampedSerializer#created |
|
|
U
|
ConversationStream#tag_events |
|
|
U
|
ConversationStream#first_item |
|
|
U
|
TimestampedSerializer#updated |
|
|
U
|
ConversationsArchive#account= |
|
|
U
|
AccountReadPolicy#initialize |
|
|
U
|
ConversationsController#list |
|
|
U
|
ConversationsController#show |
|
|
U
|
Api::MessagesController#show |
|
|
U
|
AvatarHelper#avatar_initials |
|
|
U
|
Api::AccountsController#show |
|
|
U
|
AccountsHelper#web_form_code |
|
|
U
|
Api::ConversationsController |
|
|
U
|
Conversation#to_mailbox_hash |
|
|
U
|
ConversationManager#assignee |
|
|
U
|
Chargify.subscription_status |
|
|
U
|
ConversationsArchive#account |
|
|
U
|
Users::InvitationsController |
|
|
U
|
ConversationsInbox#account= |
|
|
U
|
Webhooks::MailgunController |
|
|
U
|
TextcompleteSearch#account= |
|
|
U
|
ConversationStream#messages |
|
|
U
|
ConversationsArchive#query= |
|
|
U
|
UsersController#user_params |
|
|
U
|
MessageAuthor#email_address |
|
|
U
|
AvatarHelper#avatar_default |
|
|
U
|
Conversation#messages_count |
|
|
U
|
AccountsController#web_form |
|
|
U
|
InvitationsController#index |
|
|
U
|
Conversation#creator_person |
|
|
U
|
BillingPlan#formatted_price |
|
|
U
|
Account#conversations_limit |
|
|
U
|
Api::PeopleController#index |
|
|
U
|
MessageSerializer#body_html |
|
|
U
|
ConversationManager.manage |
|
|
U
|
ConversationsInbox#account |
|
|
U
|
WebhookSerializer#response |
|
|
U
|
TextcompleteSearch#results |
|
|
U
|
ConversationsArchive#query |
|
|
U
|
Api::AttachmentsController |
|
|
U
|
ConversationSerializer#url |
|
|
U
|
ConversationManager#manage |
|
|
U
|
TextcompleteSearch#account |
|
|
U
|
MessageMailman#deliver_to |
|
|
U
|
ConversationManager#user= |
|
|
U
|
AvatarHelper#avatar_image |
|
|
U
|
TextcompleteSearch#query= |
|
|
U
|
AccountsController#update |
|
|
U
|
Account#billing_plan_slug |
|
|
U
|
MessagesController#create |
|
|
U
|
ConversationsInbox#query= |
|
|
U
|
MessageMailman#initialize |
|
|
U
|
AccountsController#invite |
|
|
U
|
AccountsController#create |
|
|
U
|
ConversationsInbox#user= |
|
|
U
|
ConversationManager#user |
|
|
U
|
MessageAuthor#initialize |
|
|
U
|
AttachmentSerializer#url |
|
|
U
|
ConversationsInbox#query |
|
|
U
|
DashboardController#show |
|
|
U
|
TextcompleteSearch#query |
|
|
U
|
MarkdownHelper#stripdown |
|
|
U
|
MarkdownHelper#markdown |
|
|
U
|
NicknameHelper#nickname |
|
|
U
|
TextcompleteSearch.call |
|
|
U
|
AccountsController#edit |
|
|
U
|
Webhook#request_options |
|
|
U
|
Mailgun::DeliveryMethod |
|
|
U
|
Api::AccountsController |
|
|
U
|
Api::MessagesController |
|
|
U
|
MessageMailman#message= |
|
|
U
|
Chargify.management_url |
|
|
U
|
BillingsController#show |
|
|
U
|
TextcompleteSearch#tags |
|
|
U
|
AccountsController#show |
|
|
U
|
ConversationsInbox#user |
|
|
U
|
Message#mail_recipients |
|
|
U
|
MessageMailman#message |
|
|
U
|
UsersController#update |
|
|
U
|
MessageSerializer#body |
|
|
U
|
AccountsController#new |
|
|
U
|
MessageMailman.deliver |
|
|
U
|
Chargify.shared_secret |
|
|
U
|
WebhookWorker#perform |
|
|
U
|
Api::PeopleController |
|
|
U
|
PagesController#embed |
|
|
U
|
TagsController#create |
|
|
U
|
Account#stripe_token= |
|
|
U
|
Conversation#to_param |
|
|
U
|
SummaryHelper#summary |
|
|
U
|
Message#webhook_data |
|
|
U
|
Concierge#initialize |
|
|
U
|
Message#send_webhook |
|
|
U
|
Nicknamer#initialize |
|
|
U
|
MessageAuthor#people |
|
|
U
|
UsersController#edit |
|
|
U
|
Account#stripe_token |
|
|
U
|
Conversation#subject |
|
|
U
|
PagesController#docs |
|
|
U
|
PagesController#home |
|
|
U
|
BaseSerializer#type |
|
|
U
|
Nicknamer#nickname |
|
|
U
|
ActiveRecord::UUID |
|
|
U
|
Message#send_email |
|
|
U
|
Chargify.subdomain |
|
|
U
|
Webhook#signature |
|
|
U
|
Account#add_agent |
|
|
U
|
Account#add_owner |
|
|
U
|
Chargify.api_key |
|
|
U
|
Webhook#data= |
|
|
U
|
Account#owner |
|
|
U
|
Webhook#data |
|
|
U
|
Api::ConversationsController#conversation_params |
|
|
U
|
Webhooks::MailgunController#verify_webhook |
|
|
U
|
Webhooks::MailgunController#retry_webhook |
|
|
U
|
Webhooks::MailgunController#stop_webhook |
|
|
U
|
Api::MessagesController#message_params |
|
|
U
|
Account#set_default_billing_plan |
|
|
U
|
ApiController#parameter_missing |
|
|
U
|
Account#generate_webhook_secret |
|
|
U
|
Webhook#enqueue_to_send |
|
|
U
|
Webhook#fill_in_body |
|
|
U
|
WebhooksController |
|
|
U
|
AccountSerializer |
|
|
U
|
PersonSerializer |
|
|
U
|
AssignmentEvent |
|
|
U
|
CannedResponse |
|
|
U
|
ActiveRecord |
|
|
U
|
RespondLater |
|
|
U
|
ReadReceipt |
|
|
U
|
BetaInvite |
|
|
U
|
Attachment |
|
|
U
|
TagEvent |
|
|
U
|
Mailgun |
|
|
U
|
User |
|
Let's raise the visibility of documentation in Ruby!
This page is for asm-helpful/helpful-web and is part of a project called "Inch Pages", showing documentation measurements provided by Inch.
Inch Pages also provides a badge: 
(not counting low priority objects)
Can I have my own badges?
What is the goal of this?
I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.
Let's start a discussion, let's raise the visibility of documentation, let's talk.
Suggestions, feedback, critique: Hit me up on Twitter or via issue.
nch Pages