fix: should prefer `originalTitle` over `title` for settled pdf name #13

JounQin · 2025-05-13T14:28:41Z

Summary by CodeRabbit

Bug Fixes
- Improved PDF naming logic to prefer the original title over the current title, ensuring more accurate file names when downloading PDFs.
New Features
- Added support for storing and using an "original title" for site data, which is now used in relevant navigation and download features.

changeset-bot · 2025-05-13T14:28:45Z

🦋 Changeset detected

Latest commit: 4ba57fd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@alauda/doom	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-05-13T14:28:48Z

Walkthrough

This change updates the logic for determining and preserving the original site title within the application state. It introduces an originalTitle property to the site data, ensures it is set before any title overrides, and updates all relevant logic to prefer originalTitle when generating the PDF name and download link.

Changes

File(s)	Change Summary
.changeset/cyan-oranges-confess.md	Documents the patch that fixes PDF naming logic to prefer `originalTitle` over `title`.
src/global/SiteOverrides/index.tsx	Sets `siteData.originalTitle` to the current title if not already defined before applying title overrides.
src/global/VersionsNav/index.tsx	Uses `originalTitle` (if present) instead of `title` for the PDF download link and updates related memoization.
src/types.ts	Adds optional `originalTitle` property to the `SiteData` interface.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SiteOverrides
    participant SiteData
    participant VersionsNav

    User->>SiteOverrides: Triggers site override with new title
    SiteOverrides->>SiteData: Set originalTitle if undefined
    SiteOverrides->>SiteData: Override title with new value
    User->>VersionsNav: Requests PDF download link
    VersionsNav->>SiteData: Retrieve originalTitle or title
    VersionsNav-->>User: Provide download link using preferred name

Possibly related PRs

fix: pdf download link not displayed correctly #5: Addresses PDF download link issues in the same package; related in context but focuses on display rather than naming logic.

Poem

A rabbit hopped through code today,
Preserving titles in a clever way.
Now PDFs wear their proper name,
No more titles lost to override's game!
With originalTitle tucked in tight,
The download link now feels just right.
🐇✨

Tip

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fff8fb1 and 4ba57fd.

📒 Files selected for processing (4)

.changeset/cyan-oranges-confess.md (1 hunks)
src/global/SiteOverrides/index.tsx (1 hunks)
src/global/VersionsNav/index.tsx (1 hunks)
src/types.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/global/VersionsNav/index.tsx (1)

src/shared/helpers.ts (1)

getPdfName (7-8)

🔇 Additional comments (3)

src/types.ts (1)

55-58: New originalTitle property added correctly to SiteData interface

The addition of the optional originalTitle string property to the SiteData interface is correctly implemented and aligns with the PR objective to preserve the original title for PDF naming.

.changeset/cyan-oranges-confess.md (1)

1-5: Changeset properly describes the fix

The changeset file correctly describes the purpose of the patch: preferring originalTitle over title for the PDF name. This matches the PR title and the implementation.

src/global/VersionsNav/index.tsx (1)

60-61: Updated dependency for downloadLink useMemo

The downloadLink computation is correctly updated to use siteTitle instead of siteData.title, and the dependency array is appropriately updated to include siteTitle instead of siteData.title.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

@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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Signed-off-by: JounQin <admin@1stg.me>

Copilot

Pull Request Overview

This PR ensures that the settled PDF name prefers the new originalTitle over title. It introduces a new interface definition for SiteData, updates the VersionsNav component to use the correct title, and adjusts SiteOverrides to set up originalTitle via nullish assignment.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
src/types.ts	Added SiteData interface with an optional originalTitle.
src/global/VersionsNav/index.tsx	Updated pdf name generation to use originalTitle when available.
src/global/SiteOverrides/index.tsx	Applied nullish assignment to set originalTitle before updating title.

src/global/VersionsNav/index.tsx

src/global/SiteOverrides/index.tsx

pkg-pr-new · 2025-05-13T14:30:26Z

Open in StackBlitz

npm i https://pkg.pr.new/@alauda/doom@13

commit: 4ba57fd

…13)

fix: should prefer originalTitle over title for settled pdf name

41c61fb

JounQin requested a review from Copilot May 13, 2025 14:28

JounQin self-assigned this May 13, 2025

JounQin added the bug Something isn't working label May 13, 2025

Create cyan-oranges-confess.md

4ba57fd

Signed-off-by: JounQin <admin@1stg.me>

Copilot AI reviewed May 13, 2025

View reviewed changes

src/global/VersionsNav/index.tsx Show resolved Hide resolved

src/global/SiteOverrides/index.tsx Show resolved Hide resolved

JounQin merged commit dd5ff3b into main May 13, 2025
16 checks passed

JounQin deleted the fix/pdf_link branch May 13, 2025 14:35

github-actions bot mentioned this pull request May 13, 2025

chore: release @alauda/doom #14

Merged

github-actions bot pushed a commit that referenced this pull request May 13, 2025

fix: should prefer originalTitle over title for settled pdf name (#…

771f174

…13)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: should prefer `originalTitle` over `title` for settled pdf name #13

fix: should prefer `originalTitle` over `title` for settled pdf name #13

JounQin commented May 13, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented May 13, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 13, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented May 13, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fix: should prefer originalTitle over title for settled pdf name #13

fix: should prefer originalTitle over title for settled pdf name #13

Conversation

JounQin commented May 13, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fix: should prefer `originalTitle` over `title` for settled pdf name #13

fix: should prefer `originalTitle` over `title` for settled pdf name #13

JounQin commented May 13, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented May 13, 2025 •

edited

Loading

coderabbitai bot commented May 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented May 13, 2025 •

edited

Loading