docs(knowledge-base): add new resources #256
Conversation
📝 WalkthroughWalkthroughThis pull request enhances the knowledge base documentation by adding several new sections and resource cards. New sections include "🗽 Project Management" and "🗺️ Charting/Diagramming," featuring multiple cards such as the "AM Platform Development Playbook," "dbdiagram.io," "Mermaid," and "draw.io." Additionally, the "🏛️ Software Architecture" section has a new entry for "Monorepo.tools," while the "🧱 Component Libraries" section now includes "Indie UI" and "Farm UI." A new section titled "🆓 Free Stuff" has also been created, offering resources like the "GitHub Student Developer Pack" and "Figma for Students." Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/docs/content/docs/knowledge-base/index.mdx (1)
447-453: Consider reorganizing section placement.The new "Charting Resources" section is well-structured and contains valuable diagramming tools. However, consider moving it next to related sections like "Tools" or "Documentation & References" for better content organization and discoverability.
-### 🗺️ Charting Resources - -<Cards> - <Card title={"dbdiagram.io"} href={`https://dbdiagram.io/`} /> - <Card title={"Mermaid"} href={`https://mermaid.js.org/`} /> - <Card title={"draw.io"} href={`https://app.diagrams.net/`} /> -</Cards> ### 🛠️ Tools <Cards> + {/* Charting Resources */} + <Card title={"dbdiagram.io"} href={`https://dbdiagram.io/`} /> + <Card title={"Mermaid"} href={`https://mermaid.js.org/`} /> + <Card title={"draw.io"} href={`https://app.diagrams.net/`} /> + <Card title={"Database.build"} href={`https://database.build/`} />
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/docs/content/docs/knowledge-base/index.mdx(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build (20)
🔇 Additional comments (2)
apps/docs/content/docs/knowledge-base/index.mdx (2)
190-190: Great additions to the resource collection!The new resources are well-categorized and enhance the knowledge base with valuable tools:
- Monorepo.tools provides guidance for monorepo management
- Indie UI and Farm UI expand the component library options
- AM Platform Development Playbook offers valuable development guidelines
Also applies to: 283-284, 365-365
Line range hint
1-454: Well-structured additions maintaining consistency!The changes follow the established patterns in the knowledge base:
- Consistent emoji usage in section titles
- Uniform Card component usage
- Logical categorization of resources
MFarabi619
force-pushed
the
jeremy/docs/70-add-new-resources
branch
from
97008b0 to
e6d67cf
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
apps/docs/content/docs/knowledge-base/index.mdx (2)
28-32: Consider expanding the Project Management section with more resources.While the AM Platform Development Playbook is a good start, consider adding more widely-used project management resources such as:
- Agile/Scrum guides
- Popular project management tools (Jira, Trello, etc.)
- Open-source project management methodologies
Line range hint
459-467: Great addition of student resources!The GitHub Student Developer Pack and Figma for Students are valuable resources. Consider expanding this section with other student-focused resources like:
- AWS Educate
- Microsoft Azure for Students
- JetBrains Student Pack
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/docs/content/docs/knowledge-base/index.mdx(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build (20)
🔇 Additional comments (2)
apps/docs/content/docs/knowledge-base/index.mdx (2)
34-40: Great selection of diagramming tools!The chosen tools complement each other well, covering different diagramming needs from database design to general-purpose diagrams.
182-182: Excellent addition to the Software Architecture section!Monorepo.tools is a valuable resource for teams exploring monorepo architecture patterns.
| <Card title={"Indie UI"} href={`https://ui.indie-starter.dev/`} /> | ||
| <Card title={"Farm UI"} href={`https://www.farmui.com/`} /> |
There was a problem hiding this comment.
💡 Codebase verification
Remove Farm UI reference due to project abandonment
While Indie UI is actively maintained (last updated December 2024, 213 stars), Farm UI appears to be abandoned:
- Website (farmui.com) is non-functional (returns 500 error)
- No updates since August 2022
- Zero stars and community adoption
🔗 Analysis chain
Verify the maintenance status of the new UI libraries.
Let's check if these libraries are actively maintained and have a healthy community:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check the latest commit dates and stars for the UI libraries
# For Indie UI
echo "Checking Indie UI repository..."
curl -s "https://api.github.com/search/repositories?q=indie-starter+language:javascript" | jq '.items[0] | {stars: .stargazers_count, updated_at: .updated_at, created_at: .created_at}'
# For Farm UI
echo "Checking Farm UI repository..."
curl -s "https://api.github.com/search/repositories?q=farmui+language:javascript" | jq '.items[0] | {stars: .stargazers_count, updated_at: .updated_at, created_at: .created_at}'
Length of output: 706
Script:
#!/bin/bash
# Check if Farm UI website is accessible and if there are any alternative repositories
echo "Checking Farm UI website status..."
curl -I https://www.farmui.com/
echo -e "\nChecking for alternative Farm UI repositories..."
curl -s "https://api.github.com/search/repositories?q=farm-ui+OR+farm_ui+language:javascript" | jq '.items[] | {name: .full_name, stars: .stargazers_count, updated_at: .updated_at}'
Length of output: 4157
|
🎉 This PR is included in version 1.22.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Checklist
Summary by CodeRabbit