Skip to content

chore: remove deprecated documentation files#589

Merged
MervinPraison merged 1 commit intomainfrom
develop
Jun 3, 2025
Merged

chore: remove deprecated documentation files#589
MervinPraison merged 1 commit intomainfrom
develop

Conversation

@MervinPraison
Copy link
Copy Markdown
Owner

@MervinPraison MervinPraison commented Jun 3, 2025

User description

  • Deleted various obsolete documentation files to streamline the codebase.
  • Ensured minimal code changes while maintaining the integrity of the remaining documentation.

PR Type

Documentation


Description

  • Removed a large number of obsolete and deprecated documentation files from the docs/ directory and its subdirectories.

  • Streamlined the codebase by deleting outdated guides, API references, images, scripts, and configuration files.

  • Ensured that only relevant and up-to-date documentation remains, improving maintainability and clarity.


Changes walkthrough 📝

Relevant files

Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Summary by CodeRabbit

    • Documentation
      • Removed all user-facing documentation, including guides, tutorials, deployment instructions, API references, conceptual overviews, example use cases, and course materials.
      • All content related to agent configuration, usage, tools, deployment, and best practices has been deleted.
      • No user or developer documentation is available in this release.

    - Deleted various obsolete documentation files to streamline the codebase.
    - Ensured minimal code changes while maintaining the integrity of the remaining documentation.
    @netlify
    Copy link
    Copy Markdown

    netlify bot commented Jun 3, 2025

    Deploy Preview for praisonai failed.

    Name Link
    🔨 Latest commit 4a24151
    🔍 Latest deploy log https://app.netlify.com/projects/praisonai/deploys/683f3a8878fbf60008839e3b

    @MervinPraison MervinPraison merged commit f1a8931 into main Jun 3, 2025
    7 of 10 checks passed
    @coderabbitai
    Copy link
    Copy Markdown
    Contributor

    coderabbitai bot commented Jun 3, 2025

    Caution

    Review failed

    The pull request is closed.

    ## Walkthrough
    
    This change removes the entire documentation directory and its contents, including configuration files, API references, conceptual guides, developer tutorials, deployment instructions, and numerous example and course files. No code or exported entities are modified; only documentation and related static assets are deleted.
    
    ## Changes
    
    | File(s) / Path(s)                                 | Change Summary                                                                                                   |
    |--------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
    | docs/.readthedocs.yml, docs/CNAME, docs/Makefile, docs/conf.py | Deleted documentation build/configuration files (Read the Docs, CNAME, Makefile, Sphinx config).               |
    | docs/api*, docs/agents*, docs/call.mdx, docs/concepts*, docs/contributing.mdx, docs/course*, docs/deploy*, docs/developers*, docs/examples* | Deleted all documentation content: API references, agent guides, concepts, contributing, courses, deployment, developer, and example files. |
    | (All other files in docs/)                        | Removed remaining documentation markdown and HTML files, including playbooks, wrapper guides, and test docs.   |
    
    ## Sequence Diagram(s)
    
    *No sequence diagram generated, as the changes are limited to documentation and static files removal.*
    
    ## Possibly related PRs
    
    - [MervinPraison/PraisonAI#566](https://github.com/MervinPraison/PraisonAI/pull/566): Implements a human-in-the-loop approval system for tool operations, related to agent tool execution enhancements.
    
    ## Poem
    
    > The docs have hopped away, oh my!  
    > No guides or diagrams left to spy.  
    > From agents, tools, and tasks so neat,  
    > To code examples—now obsolete.  
    > But every change, as rabbits know,  
    > Prepares the ground for new docs to grow!  
    > 🐇📚✨
    ✨ 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.

    ❤️ Share
    🪧 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 @coderabbitai in a new review comment at the desired location with your query. Examples:
      • @coderabbitai explain this code block.
      • @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 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 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 generate sequence diagram to generate a sequence diagram of the changes in 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.

    @gemini-code-assist
    Copy link
    Copy Markdown
    Contributor

    Note

    Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

    @qodo-code-review
    Copy link
    Copy Markdown

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-code-review
    Copy link
    Copy Markdown

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    shaneholloman pushed a commit to shaneholloman/praisonai that referenced this pull request Feb 4, 2026
    chore: remove deprecated documentation files
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    1 participant