DevToolsArena icon indicating copy to clipboard operation
DevToolsArena copied to clipboard

230 blogs route

Open SureshPradhana opened this issue 1 year ago • 6 comments

#230

  • [x] Create a route to list all blogs.
  • [x] Add frontmatter support for tags, author information, and title slug in Markdown files.
  • [x] Implement functionality to dynamically read and parse frontmatter data.
  • [x] Implement dynamic display of tags, author information, and title slug on blog pages.

Summary by CodeRabbit

  • New Features

    • Added a comprehensive guide for new contributors on how to engage with open-source projects on GitHub.
    • Introduced a "Blogs" section in the navigation header for easier access to blog content.
    • Enabled a dedicated page for listing blog posts and dynamic routing for individual blog details.
    • Implemented a detailed blog post viewer with a table of contents for enhanced navigation and user experience.
  • Bug Fixes

    • Improved error handling and loading states in blog fetching components to enhance usability.
  • Documentation

    • Created new documentation on contributing to open source, providing clear steps and visual aids.

SureshPradhana avatar Jul 31 '24 07:07 SureshPradhana

@SureshPradhana is attempting to deploy a commit to the devvsakib's projects Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Jul 31 '24 07:07 vercel[bot]

Walkthrough

The recent changes introduce a new blogging feature to the application, allowing users to access, read, and navigate blog posts seamlessly. This includes components for listing blogs and displaying individual entries, along with enhancements to the header for easier navigation. The implementation utilizes React hooks for fetching Markdown content, ensuring a user-friendly experience with effective error handling and interactive elements.

Changes

Files Change Summary
public/blogposts/How_to_Contribute_to_Open_Source_on_GitHub_Forking_and_Making_Your_First_Pull_Request.md New guide on open-source contributions, detailing forking, cloning, branching, and making pull requests.
public/blogposts/index.json New JSON file for managing blog posts, facilitating future expansions.
src/components/Header/Header.jsx Added "Blogs" navigation item with an icon for improved access to the blog section.
src/main.jsx Introduced new routes for listing blogs (/blogs) and displaying individual blog details (/blogs/:slug), enhancing content organization.
src/pages/blogs/blog/index.jsx Created BlogDetail component to fetch and render blog content in Markdown format, including a dynamic table of contents and error handling.
src/pages/blogs/index.jsx Introduced BlogsList component to fetch and display a list of blog posts from JSON, complete with error handling and dynamic linking.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Header
    participant BlogsList
    participant BlogDetail
    participant API

    User->>Header: Click on Blogs
    Header->>BlogsList: Navigate to Blogs
    BlogsList->>API: Fetch blog posts
    API-->>BlogsList: Return blog posts
    BlogsList->>User: Display list of blog posts
    User->>BlogsList: Click on a blog post
    BlogsList->>BlogDetail: Navigate to BlogDetail
    BlogDetail->>API: Fetch blog content
    API-->>BlogDetail: Return blog content
    BlogDetail->>User: Display blog content

Poem

🐇 In the garden of code, we burrow and play,
With blogs now in bloom, brightening the way.
Forks and pull requests, oh what a delight!
A hop into open source, shining so bright!
Each click a new tale, each blog a new quest,
Join in the fun, it's the coder's best fest! 🌼


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?

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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai[bot] avatar Jul 31 '24 07:07 coderabbitai[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
github-error-solve ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 5, 2024 1:08am

vercel[bot] avatar Jul 31 '24 07:07 vercel[bot]

There are an error. image

and I don't think it makes much difference as our doc page has some content.

devvsakib avatar Aug 05 '24 01:08 devvsakib

Are you saying that the blogs route is redundant, or that the blog written there is the same as the one in the docs?

SureshPradhana avatar Aug 05 '24 02:08 SureshPradhana

image It runs perfectly locally, so the problem might be due to differences in library handling or compatibility on Vercel.

SureshPradhana avatar Aug 05 '24 05:08 SureshPradhana