Skip to content

docs: add filtering documentation and enhance Object Customization guide #236

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 12 commits into from
May 27, 2025

Conversation

shivansh
Copy link
Contributor

@shivansh shivansh commented May 25, 2025

  • Add a section on filtering.
  • Remove the beta warning at the top.
    The process to make the APIs public is in progress, and we'll anyways
    not break the beta APIs.
  • Fix headers. The Accept header is redundant, and Content-Type is mandatory.
  • Remove redundant uses of "Let's say..." while maintaining the educational tone.
  • Explain DevRev object and leaf_type.

https://app.devrev.ai/devrev/works/ISS-162751

shivansh added 3 commits May 25, 2025 20:34
The "Accept" header is redundant, and "Content-Type" is mandatory.
@shivansh shivansh requested a review from a team as a code owner May 25, 2025 15:11
Copy link
Contributor

github-actions bot commented May 25, 2025

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

@shivansh shivansh changed the title enh: add a section on filtering in the Object Customization docs docs: add filtering documentation and enhance Object Customization guide May 26, 2025
shivansh added 2 commits May 26, 2025 09:54
The process to make the APIs public is in progress, and we'll anyways
not break the beta APIs.
Copy link
Contributor

@shivansh shivansh requested a review from Atul-Butola May 27, 2025 09:18
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

This guide provides an overview of the customization framework and walks you through the process of tracking bugs in your organization. By the end of this guide, you'll be able to:
1. Customize DevRev objects such as _issue_ and _ticket_.
This section provides an overview of the customization framework and walks you through the
process of tracking bugs in your organization. By the end of this section, you'll be able
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change
process of tracking bugs in your organization. By the end of this section, you'll be able
process of tracking bugs in your organization. By the end of this section, you are able

Copy link
Contributor

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [EkLine]

In general, don't use an ellipsis. (EK00011)

"created_by": {...},

Copy link
Contributor

@shivansh shivansh merged commit 4c6477d into main May 27, 2025
6 checks passed
@shivansh shivansh deleted the shivansh/improve-docs branch May 27, 2025 13:09
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