Added SWE Docs

[sohamganatra]

PR Type

Documentation

---

Description

• Added new documentation for SweKit, including introduction, benchmarks, and workspace environments.
• Updated mint.json to include the new SweKit documentation structure.

---

Changes walkthrough 📝

Relevant files

Documentation

mint.json Add SweKit group and pages to documentation structure        docs/mint.json Added a new group SweKit with pages for introduction, workspace environments, and benchmarks. Removed unnecessary blank lines. +8/-2      benchmarks.mdx Add benchmarks documentation for SweKit                                    docs/swekit/benchmarks.mdx Added a new document for benchmarks in SweKit. Included sections on running benchmarks, workspace environments, and implementation details. +98/-0    introduction.mdx Add introduction documentation for SweKit                                docs/swekit/introduction.mdx Added an introduction document for SweKit. Included sections on key features, getting started, and next steps. +100/-0  workspace-env.mdx Add workspace environments documentation for SweKit            docs/swekit/workspace-env.mdx Added a new document for workspace environments in SweKit. Included sections on supported environments and configuring workspace environments. +149/-0

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[qodo-code-review[bot]]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[qodo-code-review[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Correct the URLs for the "Guides" and "Examples" sections to match their intended destinations It appears that the URLs for the "Guides" and "Examples" sections might have been mistakenly swapped during the update. Ensure that the URLs correctly reflect the intended destinations for each section. docs/mint.json [63-68] { "name": "Guides", - "url": "patterns" + "url": "guides" }, { "name": "Examples", - "url": "guides" + "url": "patterns" } [ ] Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies a potential mix-up in the URLs for the "Guides" and "Examples" sections, which could lead to navigation issues. Fixing this is crucial for maintaining the accuracy of the documentation.	9
Enhancement	Refactor the "pages" array in the "SweKit" group to use objects with "name" and "url" properties for consistency The newly added "SweKit" group should include a consistent structure for the "pages" array, similar to other sections. Each page should be an object with "name" and "url" properties instead of plain strings to maintain consistency and structure in the JSON file. docs/mint.json [160-165] { "group": "SweKit", "pages": [ - "swekit/introduction", - "swekit/workspace-env", - "swekit/benchmarks" + {"name": "Introduction", "url": "swekit/introduction"}, + {"name": "Workspace Environment", "url": "swekit/workspace-env"}, + {"name": "Benchmarks", "url": "swekit/benchmarks"} ] } [ ] Apply this suggestion Suggestion importance[1-10]: 8 Why: This suggestion improves the consistency and structure of the JSON file, making it easier to maintain and understand. It aligns the new "SweKit" group with the existing format used in other sections.	8
	Provide a default value for in the benchmark running instructions to enhance clarity Replace the placeholder <test_split> with a default value or example in the code snippet to avoid confusion and ensure the code is executable without modifications. This change enhances usability and clarity for users trying to run the benchmarks. docs/swekit/benchmarks.mdx [30] -python benchmark.py --test_split=<test_split> +python benchmark.py --test_split=1:100 # Example: Running 100 test instances [ ] Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding a default value for <test_split> improves usability by providing a clear example, reducing potential confusion for users trying to run the benchmarks.	7
	Replace the placeholder with an example to improve clarity in the agent creation instructions In the "Create a New Agent" step, clarify the placeholder to enhance understanding. Suggest using a specific example path or a more descriptive placeholder. docs/swekit/introduction.mdx [64] -swekit scaffold crewai -o <path> +swekit scaffold crewai -o ./your_agent_directory # Example: specify the output directory for the agent [ ] Apply this suggestion Suggestion importance[1-10]: 7 Why: Using a specific example for the <path> placeholder enhances clarity and helps users understand where to specify the output directory, improving the overall user experience.	7