chore: folder and slug instructions on readme#333
chore: folder and slug instructions on readme#333dhananjay6561 wants to merge 6 commits intokeploy:mainfrom
Conversation
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
Code Review SummaryStatus: No Issues Found | Recommendation: Merge OverviewThis PR completely rewrites the README.md with comprehensive documentation including:
The documentation is well-structured, accurate, and follows best practices for open-source project READMEs. Files Reviewed (1 file)
|
|
Hi @amaan-bhati , kindly review the PR. |
amaan-bhati
changed the title
There was a problem hiding this comment.
Pull request overview
This PR transforms the README.md from a basic WordPress + Next.js setup guide into a comprehensive technical documentation resource. The new README provides detailed information about the blog's architecture, tech stack, site structure, and deployment configuration, making it significantly more useful for developers working on the project.
Changes:
- Complete restructuring with improved organization: prerequisites and setup moved to the top, followed by detailed site mapping, tech stack documentation, and project structure
- Added extensive site map documentation covering 12 pages, 5 API routes, and navbar structure with live URL examples
- Created comprehensive tech stack table with 20+ technologies, their specific use cases, and file locations
- Enhanced with visual elements (logo, badges) and better markdown formatting throughout
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
amaan-bhati
left a comment
amaan-bhati
left a comment
There was a problem hiding this comment.
Hey @dhananjay6561 Please fix the type of server, rest all looks good to me
Signed-off-by: Dhananjay Aggarwal <133662894+dhananjay6561@users.noreply.github.com>
Signed-off-by: Dhananjay Aggarwal <133662894+dhananjay6561@users.noreply.github.com>
|
Hi @amaan-bhati implented all the suggestions as suggested by Copilot |
| - Click the **Upload Plugin** button at the top of the page and upload the WPGraphQL plugin. | ||
| - Once the plugin has been added, activate it from either the **Activate Plugin** button displayed after uploading or from the **Plugins** page. | ||
| <p align="center"> | ||
| <a href="https://nextjs.org"><img src="https://img.shields.io/badge/Next.js-18-black?logo=next.js" alt="Next.js"/></a> |
There was a problem hiding this comment.
Seems like this says "nextjs 18", it should be so, there is no nextjs 18 version released by vercel yet, we are still on 16 lol
PR Description: Comprehensive README Revamp
Overview
This PR provides a complete overhaul of the project's root README.md. The objective was to transform the documentation from a generic setup guide into a developer-friendly, technically documented resource that accurately reflects the current state of the Keploy blog website.
Previous Issues
Key Changes & Improvements
1. Technical Audit & Verification
package.jsonand source code. Every library (GSAP, Framer Motion, React Spring, Radix UI, etc.) is now listed with its specific use case and primary file locations.2. Deep Site Mapping
https://keploy.io/blog/tag/a2a).3. Structural Reorganization
4. Qualitative Enhancements
Technical Details
/blog)Verification
pages/directory structure.