wedocs-plugin
wedocs-plugin copied to clipboard
Show contributors for docs and articles in free version
Summary by CodeRabbit
- New Features
- Added display of contributor avatars for documentation articles and parent documentation posts.
- Introduced a new API endpoint to fetch contributors for specific documentation.
- Enhancements
- Contributor information is now automatically tracked and updated when documentation is edited or saved.
- Parent documentation pages aggregate contributor data from their child articles.
- Bug Fixes
- Improved handling of contributor metadata to ensure accuracy and prevent duplication.
- Other
- Updated plugin version to 2.1.12.
Walkthrough
This update introduces contributor management for documentation posts, including new backend classes, REST API endpoints, and frontend components to display contributor avatars. It adds logic to aggregate and store contributor data, updates plugin metadata, and refines UI elements to show contributor information and track upgrade button clicks.
Changes
| Files / Grouped Paths | Change Summary |
|---|---|
includes/API/API.php |
Added a REST API route to fetch contributors for a documentation post by ID, and a corresponding public method to retrieve contributor IDs from post meta. |
includes/Hooks.php |
Introduced a Hooks class to manage and synchronize contributor metadata on documentation save events, handling both parent and section posts. |
includes/WedocsContributor.php |
Added a WedocsContributor class with methods to initialize and update contributor data for articles and documentation posts, ensuring contributors are set once. |
includes/functions.php |
Introduced three functions for updating, retrieving, and aggregating documentation contributors and children, supporting the new contributor management system. |
package.json, readme.txt, wedocs.php |
Updated plugin version to 2.1.12; imported new classes; added a method to check and initialize contributors on plugin load; registered new hooks. |
src/components/Documentations/ContributorUsers.js |
Added a new React component to fetch and display up to four contributor avatars for a documentation post, with tooltips and a badge for additional contributors. |
src/components/ProPreviews/index.js |
Switched to the new ContributorUsers component for displaying contributors; updated hook filters to pass post IDs; fixed block structure. |
src/components/ProPreviews/common/UpgradeButton.js |
Updated the upgrade button URL to include UTM parameters for tracking. |
Suggested labels
QA Approved, Ready To Merge
Suggested reviewers
- iftakharul-islam
Poem
🐇
Hopping through docs, I see
Contributors now, as clear as can be!
Avatars twinkle, updates anew,
Version bumps and APIs too.
With every save, our credits grow—
In the garden of docs, let contributors show!
🌱✨
[!NOTE]
⚡️ AI Code Reviews for VS Code, Cursor, Windsurf
CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more here.
[!NOTE]
⚡️ Faster reviews with caching
CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure
Review - Disable Cacheat either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off theData Retentionsetting under your Organization Settings. Enjoy the performance boost—your workflow just got faster.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 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.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 explain its main purpose.@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.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.