chore: remove deprecated documentation files#589
Conversation
- Deleted various obsolete documentation files to streamline the codebase. - Ensured minimal code changes while maintaining the integrity of the remaining documentation.
❌ Deploy Preview for praisonai failed.
|
|
Caution Review failedThe 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
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Note Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported. |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
chore: remove deprecated documentation files
User description
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 📝
Summary by CodeRabbit