Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Data Stories enhanced #120

Merged
merged 3 commits into from
Mar 12, 2024
Merged

Data Stories enhanced #120

merged 3 commits into from
Mar 12, 2024

Conversation

maehr
Copy link
Member

@maehr maehr commented Mar 12, 2024

Pull request

Proposed changes

Types of changes

  • New feature (non-breaking change which adds functionality).
  • Enhancement (non-breaking change which enhances functionality)
  • Bug Fix (non-breaking change which fixes an issue).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist

  • I have read the README document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Summary by CodeRabbit

  • New Features
    • Introduced a new section explaining what a Data Story is.
    • Updated the Data Stories page to display additional information such as descriptions and creation dates for each story.
  • Enhancements
    • Enhanced page metadata with dynamic descriptions for better SEO.
    • Improved introductory text for a more engaging user experience.

Copy link

changeset-bot bot commented Mar 12, 2024

⚠️ No Changeset found

Latest commit: 99d1d33

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

coderabbitai bot commented Mar 12, 2024

Warning

Rate Limit Exceeded

@maehr has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 18 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 9d53b33 and 99d1d33.

Walkthrough

The recent update enhances the data stories section of the website by adding a detailed explanation of what a data story is, incorporating a dynamic description in the page's header, and updating the introductory text for clarity. It also enriches the list of data stories with descriptions and creation dates, and introduces three specific data stories, fulfilling the objective to make data more engaging and accessible.

Changes

File Changes
.../+page.svelte - Added explanation and definition of Data Stories.
- Updated page header and introductory text.
- Enhanced list display with descriptions and dates.

Assessment against linked issues

Objective Addressed Explanation
Add a "Data Stories" section to the website (#119)
Include descriptions of specific Data Stories (#119)
Define what a Data Story is (#119)
Emphasize the interactive nature of Data Stories (#119) It's unclear if the interactivity of Data Stories is highlighted without seeing the content of whatIsADataStory.
Enhance digital communication through Data Stories (#119)

🐇🎉
To the tales of data, we've given a home,
Where stories of Basel's past freely roam.
With descriptions rich and dates anew,
We've painted our history with a digital hue.
📜✨ Here's to stories told, in bytes and bits,
A rabbit's work, where history sits.
🥕🎈 Let's hop into tales, both old and grand,
In Basel's digital land we stand.
🐇🌟

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@maehr maehr requested review from koilebeit, mtwente and a team March 12, 2024 15:30
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e6e6054 and edd9b38.
Files ignored due to path filters (1)
  • src/lib/data/datastories.json is excluded by: !**/*.json
Files selected for processing (1)
  • src/routes/data-stories/+page.svelte (1 hunks)
Additional comments: 5
src/routes/data-stories/+page.svelte (5)
  • 6-7: The whatIsADataStory constant provides a detailed explanation of what a Data Story is, which is great for user understanding. However, consider breaking this long string into multiple lines or storing it externally for better readability and maintainability.
  • 9-10: The toLocaleDateString function is a nice addition for formatting dates in a user-friendly manner. Ensure that the 'de-CH' locale is appropriate for all users of the website or consider making the locale dynamic based on the user's preferences or browser settings.
  • 22-22: The change in the introductory text to "Wir bieten Ihnen folgende Data Stories:" is a positive update, making the introduction more inviting and clear to the users.
  • 24-29: Enhancing the presentation of each Data Story with additional information like description and creation date is a significant improvement. This change makes the stories more informative and engaging. Ensure that the date format is consistent and understandable for the target audience.
  • 32-35: Adding a new section with the heading "Was ist eine Datastory?" and the content of whatIsADataStory is a valuable addition for educating users about the concept of Data Stories. This aligns well with the objectives of making data more engaging and accessible.

src/routes/data-stories/+page.svelte Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between edd9b38 and 9d53b33.
Files ignored due to path filters (1)
  • src/lib/data/datastories.json is excluded by: !**/*.json
Files selected for processing (1)
  • src/routes/data-stories/+page.svelte (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/routes/data-stories/+page.svelte

@maehr maehr merged commit d139493 into Stadt-Geschichte-Basel:main Mar 12, 2024
3 checks passed
@maehr maehr deleted the datastories branch March 12, 2024 21:48
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.

Add explanation about data stories
3 participants