Skip to content

Add preview feature for articles - #941

Merged
NiallJoeMaher merged 2 commits into
codu-code:developfrom
NiallJoeMaher:feat/preview-articles-link
Jun 8, 2024
Merged

Add preview feature for articles#941
NiallJoeMaher merged 2 commits into
codu-code:developfrom
NiallJoeMaher:feat/preview-articles-link

Conversation

@NiallJoeMaher

Copy link
Copy Markdown
Contributor

✨ Codu Pull Request 💻

Codu Logo

Pull Request details

  • Now you can use draft/POST_ID to share preview of unpublished articles

@NiallJoeMaher
NiallJoeMaher requested a review from a team as a code owner June 7, 2024 19:14
@vercel

vercel Bot commented Jun 7, 2024

Copy link
Copy Markdown

@NiallJoeMaher is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 7, 2024

Copy link
Copy Markdown
Contributor

Warning

Review failed

The pull request is closed.

Walkthrough

The recent updates introduce functionality for generating metadata and rendering post previews using React and Markdoc parsing. Additionally, they enhance the server-side logic for fetching post previews and update the robots.txt configuration to disallow the /draft/ path.

Changes

Files Change Summary
app/(app)/draft/[id]/page.tsx Added metadata generation and post preview rendering with React and Markdoc. Introduced PreviewPage component and Props type.
app/robots.ts Updated robots() function to disallow /draft/ path.
server/lib/posts.ts Added GetPreviewSchema constant, GetPreview type, and getPostPreview function for fetching post previews.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Browser
    participant Server
    participant Markdoc
    participant React

    User->>Browser: Navigate to /draft/[id]
    Browser->>Server: Request post preview data
    Server->>Server: Fetch data using getPostPreview
    Server->>Browser: Send post preview data
    Browser->>React: Render PreviewPage component
    React->>Markdoc: Parse post content
    Markdoc->>React: Return parsed content
    React->>Browser: Display post preview
Loading

Poem

In the world of code, a change so grand,
Previewing drafts with a gentle hand.
Metadata gleams, posts come to life,
Markdoc and React, free from strife.
Robots now know where not to tread,
In this digital garden, well-read. 🌟


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 Configration 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 coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (2)
app/(app)/draft/[id]/page.tsx (1)

38-38: Consider removing the debug statement before merging to maintain clean production code.

server/lib/posts.ts (1)

74-74: Consider removing the debug statement to maintain clean production code.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0edaaa3 and f604005.

Files selected for processing (3)
  • app/(app)/draft/[id]/page.tsx (1 hunks)
  • app/robots.ts (1 hunks)
  • server/lib/posts.ts (3 hunks)
Files skipped from review due to trivial changes (1)
  • app/robots.ts
Additional comments not posted (4)
app/(app)/draft/[id]/page.tsx (2)

16-34: The implementation of generateMetadata function looks robust and handles edge cases well.


37-78: The PreviewPage component is well-structured and handles edge cases appropriately.

server/lib/posts.ts (2)

13-22: The GetPreviewSchema and its inferred type are correctly defined and follow best practices for type safety.


70-111: The getPostPreview function is well-implemented with robust error handling and proper use of async/await patterns.

@vercel

vercel Bot commented Jun 8, 2024

Copy link
Copy Markdown

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

Name Status Preview Comments Updated (UTC)
codu ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 8, 2024 11:32am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant