Skip to content

Update Custom Certificates.md #309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025

Conversation

mahajantejas
Copy link
Collaborator

@mahajantejas mahajantejas commented Apr 15, 2025

updated with a screenshot on how to properly use "split by condition" to validate if the contact variables contains a value before sending the certificate

Summary by CodeRabbit

  • Documentation
    • Improved readability of a code example by using a fenced code block.
    • Added an illustrative image of the "File → Page Setup" menu.

updated with a screenshot on how to properly use "split by condition" to validate if the contact variables contains a value before sending the certificate
Copy link

coderabbitai bot commented Apr 15, 2025

Walkthrough

The change updates the "Custom Certificates" documentation by modifying the formatting of a validation code example, switching from inline code to a fenced code block for better readability. Additionally, it introduces a new image that visually demonstrates the "File → Page Setup" menu, placed directly after the code example. There are no modifications to the logic or explanatory content of the documentation.

Changes

File(s) Change Summary
docs/3. Product Features/Custom Certificates.md Reformatted a validation code example from inline to a fenced code block and added an illustrative image after the code block. No changes to logic or step explanations.

Possibly related PRs

Suggested reviewers

  • SangeetaMishr

Poem

In the docs, a code block shines bright,
No longer inline, it stands upright.
An image appears with a menu in view,
Making instructions easy to pursue.
With every hop, clarity grows—
This rabbit loves how documentation flows! 🐇📄

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@github-actions github-actions bot temporarily deployed to pull request April 15, 2025 09:06 Inactive
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/3. Product Features/Custom Certificates.md (1)

138-140: Specify the language for the fenced code block.

For better readability and to resolve markdownlint warnings, specify the language (e.g., elixir or eex) after the opening backticks:

-```
+```elixir
<%=  ["@contact.name", "@contact.abcd"] |> Enum.any?(&String.starts_with?(&1, "@")) %>
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

138-138: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 39575bd and 865fa53.

📒 Files selected for processing (1)
  • docs/3. Product Features/Custom Certificates.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/3. Product Features/Custom Certificates.md

138-138: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

🔇 Additional comments (1)
docs/3. Product Features/Custom Certificates.md (1)

141-141: Screenshot addition is clear and helpful.

The new screenshot visually clarifies the "split by condition" feature and is well-placed after the code example.

@SangeetaMishr SangeetaMishr merged commit aa8be17 into main Apr 15, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants