Update customcertificatesdocumentation #308
Conversation
Uploaded the summary of work for done for SArC which lists 4 use cases of using google sheets and contact variables and custom expressions.
made minor changes as per feedback from product team
WalkthroughThis pull request updates the custom certificates documentation and adds a new document describing the integration of Google Sheets with AI assistants for the Saturday Art Class program. The certificates document now reflects corrected resolution values, reworded instructions, and additional steps for granting access and saving templates, while error handling instructions have been modified. The new use cases document details how keywords, counters, and fuzzy matching are used to streamline teacher interactions and manage media storage. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GoogleSlides
participant Glific
User->>GoogleSlides: Create certificate with resolution 3300x2550
GoogleSlides-->>User: Provide slide URL (2nd slide)
User->>Glific: Use URL to create certificate template
Glific-->>User: Save certificate and display "copy id" button
User->>GoogleSlides: Grant editor access to service account
Note over User, GoogleSlides: Handle errors by deleting specified slides
sequenceDiagram
participant Teacher
participant Chatbot
participant GoogleSheets
Teacher->>Chatbot: Send keyword/request for art class plan
Chatbot->>GoogleSheets: Query contact variables and metadata
GoogleSheets-->>Chatbot: Return plan details and media info
Chatbot-->>Teacher: Deliver art class plan with instructions
Possibly related PRs
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚀 Deployed on https://deploy-preview-308--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (16)
docs/Use Cases/Use of Google Sheets To Update Contact Variables.md (11)
3-4: Use Gender-Neutral Language in Summary
In the summary (line 4), the phrase “for the grades she is teaching” could be revised to “for the grades they are teaching” (or another gender‐neutral alternative) to improve inclusivity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~4-~4: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ich can be conducted for the grades she is teaching, and enable submission of pict...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
7-9: Enhance Clarity and Grammar in Problem Statement
The second problem statement (lines 7–9) would benefit from correcting pluralization (e.g. “art classes” instead of “art class”) and rephrasing for clarity. For example, you might consider:“To solve data analysis challenges: the SArC team needs to determine how many art classes are accessed by each teacher, which class is being conducted at any given time, and the overall submission rates.”
🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...rC team unable to find out how many art class are accessed by a particular teacher, w...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~9-~9: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...y a particular teacher, which art class is the teacher doing at any given point in time and ov...(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[style] ~9-~9: This phrase is redundant. Consider writing “point” or “time”.
Context: ...class is the teacher doing at any given point in time and overall submission rates. Owing to ...(MOMENT_IN_TIME)
16-16: Punctuation Enhancement for Clarity
The sentence on line 16 could be improved by adding a missing comma for clarity. For example,-Each partner org associated with the SArC, conducting SArC programs with their respective teachers is given a keyword. +Each partner org associated with the SArC, conducting SArC programs with their respective teachers, is given a keyword.🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: Possible missing comma found.
Context: ...ing SArC programs with their respective teachers is given a keyword. This keyword is use...(AI_HYDRA_LEO_MISSING_COMMA)
39-39: Correct Typographical Errors
On line 39, “pulled form the google sheet” should be corrected to “pulled from the Google sheet” with “Google” capitalized as it is a proper noun. For example:-... pulled form the google sheet. +... pulled from the Google sheet.🧰 Tools
🪛 LanguageTool
[style] ~39-~39: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...or each grade, to ensure that a teacher is able to access only one art class plan at a tim...(BE_ABLE_TO)
28-28: Simplify Redundant Phrasing
In list item 5 (line 28), the phrase “Owing to the fact that in a week a teacher can go to multiple grades” can be simplified. Consider rephrasing to:“... since a teacher can teach multiple grades in a week.”
45-46: Correct Terminology in Use Case Title
The title on line 45 refers to “Fuzzy keyword matching to identify the closed actual keyword.” It appears “closed” is a typographical error; it should likely be “closest.”
54-54: Fix Grammatical Errors in Use Case 4 Description
On line 54, the sentence “As SArC engages a numerous teachers…” should be updated to “As SArC engages numerous teachers…” Additionally, change “in terms on actual engagement” to “in terms of actual engagement.”
60-60: Proper Noun Capitalization
On line 60, update “google drive” to “Google Drive” to respect the proper noun.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...ed on the values present in the contact variables as opposed to being dumped into the “up...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: Did you mean “Google Drive”?
Context: ...dumped into the “uploads” folder of the google drive. An example folder structure. "Upload...(GOOGLE_PRODUCTS)
65-65: Hyphenate Idiomatic Expression
On line 65, consider hyphenating “from the get go” to “from the get-go” for proper idiomatic usage.🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: A comma might be missing here.
Context: ...d684bc-53c5-4b7f-9568-321d3e4ecaeb" /> Similarly based on the contact variables of org n...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
64-64: Correct Verb Form
In the conclusion (line 64), the phrase “involved implement a fairly complex logic” should be corrected to “involved implementing a fairly complex logic.”
66-66: Enhance Preposition Usage
On line 66, change “refer this documentation” to “refer to this documentation” to improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: In this idiom, “get-go” is spelled with a hyphen.
Context: ...ed by a teacher will be sorted from the get go into this folder structure. ## Credi...(FROM_THE_GET_GO)
docs/3. Product Features/Custom Certificates.md (5)
76-76: Clarify Instruction for Certificate Template Creation
On line 76, consider revising the instruction to:“The URL on the 2nd slide will be used to create the certificate template on Glific.”
This change improves clarity and maintains consistency in formatting.
80-80: Capitalization of “Google”
On line 80, “google service account’s client email address” should use “Google” as a proper noun.-Provide editor access to the google service account’s client email address. +Provide editor access to the Google service account’s client email address.🧰 Tools
🪛 LanguageTool
[grammar] ~80-~80: “Google” is a proper noun and needs to be capitalized.
Context: ...ef" /> 8. Provide editor access to the google service account’s client email address....(A_GOOGLE)
84-84: Improve Clarity in Certificate URL Step
On line 84, consider rephrasing to:“Certificate URL is the link to the Google Slide template obtained by copying the link.”
This revision both clarifies the instruction and ensures proper capitalization.🧰 Tools
🪛 LanguageTool
[uncategorized] ~84-~84: You might be missing the article “the” here.
Context: ...262-36fc-4f11-b403-926bcbf17197" /> 9. Certificate url is the link to the google slide tem...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~84-~84: “Google” is a proper noun and needs to be capitalized.
Context: ... 9. Certificate url is the link to the google slide template taken by copying the lin...(A_GOOGLE)
98-98: Enhance Clarity in Placeholder Instruction
On line 98, adding the article “the” would improve clarity. For example:-Ensure that the placeholders have a large enough text field to accommodate the information for contact being sent +Ensure that the placeholders have a large enough text field to accommodate the information for the contact being sent🧰 Tools
🪛 LanguageTool
[uncategorized] ~98-~98: Possible missing article found.
Context: ...ield to accommodate the information for contact being sent 6. The certificate is saved,...(AI_HYDRA_LEO_MISSING_THE)
99-99: Refine Instruction Wording
On line 99, consider changing “refer back to the template” to “refer to the template” to reduce wordiness.🧰 Tools
🪛 LanguageTool
[style] ~99-~99: ‘refer back’ might be wordy. Consider a shorter alternative.
Context: ..., and the copy id button can be used to refer back to the template while using the webhook...(EN_WORDINESS_PREMIUM_REFER_BACK)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/3. Product Features/Custom Certificates.md(4 hunks)docs/Use Cases/Use of Google Sheets To Update Contact Variables.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/Use Cases/Use of Google Sheets To Update Contact Variables.md
[uncategorized] ~4-~4: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ich can be conducted for the grades she is teaching, and enable submission of pict...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~9-~9: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...rC team unable to find out how many art class are accessed by a particular teacher, w...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~9-~9: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...y a particular teacher, which art class is the teacher doing at any given point in time and ov...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[style] ~9-~9: This phrase is redundant. Consider writing “point” or “time”.
Context: ...class is the teacher doing at any given point in time and overall submission rates. Owing to ...
(MOMENT_IN_TIME)
[uncategorized] ~16-~16: Possible missing comma found.
Context: ...ing SArC programs with their respective teachers is given a keyword. This keyword is use...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~23-~23: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...following key considerations 1. Provide a art class plan (PDF file) in the prefer...
(EN_A_VS_AN)
[uncategorized] ~26-~26: The preposition “with” seems more likely in this position.
Context: ...4. The art class plans should be shared to the teacher in sequential order, that i...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...o the teacher in sequential order, that is the teacher should not have to make dec...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~26-~26: You might be missing the article “a” here.
Context: ... is the teacher should not have to make decision on which plan number she has to get thi...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[style] ~27-~27: ‘Owing to the fact that’ might be wordy. Consider a shorter alternative.
Context: ...le art class plans from the same grade. Owing to the fact that in a week a teacher can go to multiple...
(EN_WORDINESS_PREMIUM_OWING_TO_THE_FACT_THAT)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...same grade. Owing to the fact that in a week a teacher can go to multiple grades. ...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~37-~37: ‘So as to’ expresses purpose and is used in formal texts. Consider using “to”.
Context: ...nters of art class plan for each grade, so as to serve the next art class plan for that ...
(SO_AS_TO)
[style] ~37-~37: ‘So as to’ expresses purpose and is used in formal texts. Consider using “to”.
Context: ...re this info and increment it logically so as to deliver the plans in a sequential manne...
(SO_AS_TO)
[style] ~37-~37: Consider replacing this phrase with the adverb “sequentially” to avoid wordiness.
Context: ...it logically so as to deliver the plans in a sequential manner. 2. Flags for art class plans for eac...
(IN_A_X_MANNER)
[style] ~39-~39: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...or each grade, to ensure that a teacher is able to access only one art class plan at a tim...
(BE_ABLE_TO)
[grammar] ~41-~41: The correct preposition here is “on” or “about”.
Context: ...tact variables to store the information of the grade and art class plan number bei...
(INFORMATION_OF)
[uncategorized] ~41-~41: “form” (shape/structure, to make) seems less likely than “from” (“originating from”).
Context: ...r the art class plan after being pulled form the google sheet. 4. Contact variable...
(AI_HYDRA_LEO_CP_FORM_FROM)
[grammar] ~41-~41: “Google” is a proper noun and needs to be capitalized.
Context: ... class plan after being pulled form the google sheet. 4. Contact variable to store t...
(A_GOOGLE)
[grammar] ~43-~43: The correct preposition here is “on” or “about”.
Context: ...ntact variable to store the information of grade and art class plan number being s...
(INFORMATION_OF)
[style] ~43-~43: Consider a shorter alternative to avoid wordiness.
Context: ...d art class plan number being submitted in order to record the completion. This contact hol...
(IN_ORDER_TO_PREMIUM)
[grammar] ~43-~43: The correct preposition here is “on” or “about”.
Context: ...ion. This contact holds the information of the previous art class plan that the te...
(INFORMATION_OF)
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...r sometimes makes typos in entering the keyword ex: the expected keyword is cae, and th...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~48-~48: ‘by mistake’ might be wordy. Consider a shorter alternative.
Context: ...xpected keyword is cae, and the teacher by mistake enters cse or caw or something similar....
(EN_WORDINESS_PREMIUM_BY_MISTAKE)
[uncategorized] ~53-~53: You might be missing the article “a” here.
Context: ...tact is not part of any flow, and sends keyword which is not linked to any active flow....
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[grammar] ~57-~57: “Google” is a proper noun and needs to be capitalized.
Context: ...y teachers in structured folders in the google cloud storage bucket. As SArC engages ...
(A_GOOGLE)
[uncategorized] ~58-~58: Did you mean “numerous teachers”?
Context: ... cloud storage bucket. As SArC engages a numerous teachers, across numerous grades and has multipl...
(A_NUMEROUS_WORDS)
[uncategorized] ~58-~58: A comma might be missing here.
Context: ... communication material. And at another level this also helps to triangulate the prog...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~58-~58: The preposition “of” seems more likely in this position.
Context: ...chers from any particular org, in terms on actual engagement and completion of the...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...ed on the values present in the contact variables as opposed to being dumped into the “up...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: Did you mean “Google Drive”?
Context: ...dumped into the “uploads” folder of the google drive. An example folder structure. "Upload...
(GOOGLE_PRODUCTS)
[uncategorized] ~65-~65: A comma might be missing here.
Context: ...d684bc-53c5-4b7f-9568-321d3e4ecaeb" /> Similarly based on the contact variables of org n...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~66-~66: In this idiom, “get-go” is spelled with a hyphen.
Context: ...ed by a teacher will be sorted from the get go into this folder structure. ## Credi...
(FROM_THE_GET_GO)
[uncategorized] ~70-~70: Possible missing comma found.
Context: ...previous iteration of implementing this program which ran successfully over the chatbot...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~73-~73: This verb may not be in the correct form. Consider using a different form for this context.
Context: ... ## Conclusion This project involved implement a fairly complex logic that informs the...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~75-~75: Possible missing preposition found.
Context: ... chatbot flows more logic driven, refer this documentation. Reach out to tejas@gli...
(AI_EN_LECTOR_MISSING_PREPOSITION)
docs/3. Product Features/Custom Certificates.md
[grammar] ~80-~80: “Google” is a proper noun and needs to be capitalized.
Context: ...ef" /> 8. Provide editor access to the google service account’s client email address....
(A_GOOGLE)
[uncategorized] ~84-~84: You might be missing the article “the” here.
Context: ...262-36fc-4f11-b403-926bcbf17197" /> 9. Certificate url is the link to the google slide tem...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~84-~84: “Google” is a proper noun and needs to be capitalized.
Context: ... 9. Certificate url is the link to the google slide template taken by copying the lin...
(A_GOOGLE)
[uncategorized] ~98-~98: Possible missing article found.
Context: ...ield to accommodate the information for contact being sent 6. The certificate is saved,...
(AI_HYDRA_LEO_MISSING_THE)
[style] ~99-~99: ‘refer back’ might be wordy. Consider a shorter alternative.
Context: ..., and the copy id button can be used to refer back to the template while using the webhook...
(EN_WORDINESS_PREMIUM_REFER_BACK)
🪛 markdownlint-cli2 (0.17.2)
docs/Use Cases/Use of Google Sheets To Update Contact Variables.md
21-21: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
57-57: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
77-77: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (2)
docs/3. Product Features/Custom Certificates.md (2)
52-52: Resolution Correction for Landscape Certificates
The updated resolution “3300 x 2550 px” for landscape certificates is now correct and aligns with the intended design specifications.
158-158: Error Handling Slide Deletion Correction
The instruction in the error-handling section now advises “Delete the slide 1 and 2” (line 158), which aligns with the updated resolution process. Ensure this change has been tested with the Google Slides workflow.
updated as per feedbacks from the product team
Summary by CodeRabbit