Skip to content
This repository was archived by the owner on Aug 10, 2026. It is now read-only.

[WEB-4100] - new design footer - #2330

Closed
aralovelace wants to merge 33 commits into
web-4082-docs-nav-redesignfrom
WEB-4100_Footer
Closed

[WEB-4100] - new design footer#2330
aralovelace wants to merge 33 commits into
web-4082-docs-nav-redesignfrom
WEB-4100_Footer

Conversation

@aralovelace

@aralovelacearalovelace commented Dec 6, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

Description

WEB-4100 Footer redesign - this view only suits for layout that has left side bar.
This is just the first phase, things left to do is for the footer to display correctly for different layouts, which needed to be done once the layout component has been refactored.

Removed a lot of components and just add them in one Footer component

This pull request includes significant updates to the footer component of the website, involving restructuring and refactoring for better organization and maintainability. The changes include updating the footer menu items, removing unused components, and introducing new ones.

Footer Component Updates:

  • Updated the footer bottom menu items in data/yaml/page-furniture/footerBottomMenu.yaml to include new links and positions.
  • Removed the FooterMenu structure from data/yaml/page-furniture/footerMenu.yaml, simplifying the footer navigation.
  • Refactored src/components/Footer/Footer.tsx to integrate new footer layout and functionalities, including the introduction of FooterStatus and dynamic link display based on position.

Component Removal and Refactoring:

  • Removed FooterBottomNav component and its references, consolidating its functionality into the main Footer component.
  • Removed FooterTopNav and its related components (FooterLogo, FooterMenu, FooterMenuContainer, FooterSocialMenu, FooterSocialMenuIcons) to streamline the footer structure. [1][2][3][4][5][6]

Other Changes:

  • Renamed and refactored FooterStatus component for better clarity and integration within the new footer structure. [1][2][3]
  • Updated social links data in src/components/Footer/data.ts to include new social media platforms and update existing ones.
  • Minor updates to snapshot tests to reflect the changes in the footer component styling and structure. [1][2][3]
  • Adjusted import paths in src/external-scripts/index.ts for better modularity.

Review

Instructions on how to review the PR.

  • check the footer of this page /products/channels

Summary by CodeRabbit

  • New Features

    • Updated footer menu structure with new items: "Changelog," "About Ably," and "Blog."
    • Introduced a new FooterStatus component for enhanced footer layout.

  • Bug Fixes

    • Adjusted social media links in the footer; removed outdated entries and added X (formerly Twitter).

  • Chores

    • Removed several deprecated components related to footer navigation for a cleaner codebase.

@aralovelacearalovelace self-assigned this Dec 6, 2024
@coderabbitai

coderabbitaiBot commented Dec 6, 2024•
edited
Loading

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve a significant restructuring of the footer component in the application. The footerBottomMenu.yaml file has been updated to modify the footer menu items, changing their positions and adding new items. Several components related to the footer, including FooterTopNav, FooterBottomNav, and associated menu components, have been removed. A new component, FooterStatus, has been introduced, along with modifications to how bottom links are displayed. Additionally, some social media links have been modified in the data.ts file, and an import path in index.ts has been updated.

Changes

File PathChange Summary
data/yaml/page-furniture/footerBottomMenu.yamlModified footer menu items, changed quotation style, added new items, and updated their positions.
data/yaml/page-furniture/footerMenu.yamlRemoved the entire footerMenu.yaml file.
src/components/Footer/Footer.tsxRemoved FooterTopNav and FooterBottomNav, added FooterStatus, and updated rendering logic.
src/components/Footer/FooterBottomNav.tsxDeleted FooterBottomNav component.
src/components/Footer/FooterStatus.tsxUpdated state type, modified JSX structure, and adjusted data fetching logic.
src/components/Footer/FooterTopNav.tsxDeleted FooterTopNav component.
src/components/Footer/FooterTopNav/FooterLogo.tsxDeleted FooterLogo component.
src/components/Footer/FooterTopNav/FooterMenu/FooterMenu.tsxDeleted FooterMenu component and its type definition.
src/components/Footer/FooterTopNav/FooterMenu/FooterMenuContainer.tsxDeleted FooterMenuContainer component.
src/components/Footer/FooterTopNav/FooterSocial/FooterSocialMenu.tsxDeleted FooterSocialMenu component.
src/components/Footer/FooterTopNav/FooterSocial/FooterSocialMenuIcons.tsxDeleted FooterSocialMenuIcons component.
src/components/Footer/data.tsModified ablySocialLinks by removing Twitter and Stack Overflow entries and adding X.
src/external-scripts/index.tsUpdated import path for the announcement module.

Assessment against linked issues

ObjectiveAddressedExplanation
Implement new header and footer for docs (WEB-4100)✅

🐇 In the footer, we made a change,
New links and items, a fresh new page!
With Changelog and Blog now in sight,
Our footer's brighter, oh what a delight!
Goodbye to the old, we hop to the new,
With every link, a journey for you! 🌟

🪧 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.
    • 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 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 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 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. (Beta)
  • @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.

@ably-ci
ably-ci temporarily deployed to ably-docs-web-4100-foot-qi5f5y December 6, 2024 17:23 Inactive
@aralovelacearalovelace changed the title [WEB-4100] - WIP: new design footer[WEB-4100] - new design footerDec 12, 2024
@aralovelace
aralovelace marked this pull request as ready for review December 12, 2024 13:45
@aralovelace

aralovelace commented Dec 12, 2024

Copy link
Copy Markdown
ContributorAuthor

@coderabbitai review

@coderabbitai

coderabbitaiBot commented Dec 12, 2024

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@aralovelace

aralovelace commented Dec 12, 2024

Copy link
Copy Markdown
ContributorAuthor

@coderabbitai review

@coderabbitai

coderabbitaiBot commented Dec 12, 2024

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai[bot]
coderabbitaiBot reviewed Dec 12, 2024
View reviewed changes

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (1)
src/components/Footer/FooterStatus.tsx (1)

52-53: Include 'noopener' in the 'rel' attribute for security

When using target="_blank", it is recommended to include 'noopener' in the rel attribute to prevent potential security risks related to the window.opener property.

Apply this diff to enhance security:

- rel="noreferrer"+ rel="noopener noreferrer"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2382ebf and de284f5.

⛔ Files ignored due to path filters (3)
  • src/components/Footer/FooterTopNav/images/ably-logo.png is excluded by !**/*.png
  • src/components/blocks/Html/__snapshots__/Html.test.tsx.snap is excluded by !**/*.snap
  • src/components/blocks/wrappers/__snapshots__/ConditionalChildrenLanguageDisplay.test.js.snap is excluded by !**/*.snap
📒 Files selected for processing (13)
  • data/yaml/page-furniture/footerBottomMenu.yaml (1 hunks)
  • data/yaml/page-furniture/footerMenu.yaml (0 hunks)
  • src/components/Footer/Footer.tsx (1 hunks)
  • src/components/Footer/FooterBottomNav.tsx (0 hunks)
  • src/components/Footer/FooterStatus.tsx (3 hunks)
  • src/components/Footer/FooterTopNav.tsx (0 hunks)
  • src/components/Footer/FooterTopNav/FooterLogo.tsx (0 hunks)
  • src/components/Footer/FooterTopNav/FooterMenu/FooterMenu.tsx (0 hunks)
  • src/components/Footer/FooterTopNav/FooterMenu/FooterMenuContainer.tsx (0 hunks)
  • src/components/Footer/FooterTopNav/FooterSocial/FooterSocialMenu.tsx (0 hunks)
  • src/components/Footer/FooterTopNav/FooterSocial/FooterSocialMenuIcons.tsx (0 hunks)
  • src/components/Footer/data.ts (1 hunks)
  • src/external-scripts/index.ts (1 hunks)
💤 Files with no reviewable changes (8)
  • src/components/Footer/FooterTopNav/FooterSocial/FooterSocialMenuIcons.tsx
  • src/components/Footer/FooterBottomNav.tsx
  • src/components/Footer/FooterTopNav/FooterLogo.tsx
  • data/yaml/page-furniture/footerMenu.yaml
  • src/components/Footer/FooterTopNav/FooterMenu/FooterMenuContainer.tsx
  • src/components/Footer/FooterTopNav.tsx
  • src/components/Footer/FooterTopNav/FooterSocial/FooterSocialMenu.tsx
  • src/components/Footer/FooterTopNav/FooterMenu/FooterMenu.tsx
✅ Files skipped from review due to trivial changes (1)
  • src/external-scripts/index.ts
🔇 Additional comments (2)
src/components/Footer/Footer.tsx (1)

45-71: Footer layout updated appropriately

The footer layout has been successfully updated to integrate the new FooterStatus component and reorganize social links and bottom links as intended. The use of flexbox and responsive classes enhances the footer's responsiveness across different screen sizes.

src/components/Footer/data.ts (1)

6-6: Verify the availability of 'icon-social-x' in the icon library

Ensure that the icon named 'icon-social-x' exists in the icon library so that the X (formerly Twitter) social link displays correctly. If the icon is not available, it will result in a missing icon or error.

Run the following script to check for the existence of 'icon-social-x':

Comment threadsrc/components/Footer/Footer.tsx
Comment threadsrc/components/Footer/Footer.tsx
Comment threaddata/yaml/page-furniture/footerBottomMenu.yaml
Comment threadsrc/components/Footer/FooterStatus.tsx Outdated
@aralovelace
aralovelaceforce-pushed the WEB-4100_Footer branch 2 times, most recently from a323693 to 9412280CompareDecember 12, 2024 14:58
@aralovelace
aralovelace changed the base branch from main to web-4082-docs-nav-redesignDecember 12, 2024 14:59
@aralovelace
aralovelaceforce-pushed the WEB-4100_Footer branch 2 times, most recently from e429fd2 to 0e59008CompareDecember 12, 2024 15:14
@jamiehenson
jamiehensonforce-pushed the web-4082-docs-nav-redesign branch from 773642f to 2382ebfCompareDecember 12, 2024 16:12
@jamiehenson
feat: remove old sidebar logic and introduce early simplified successor
02a0b46
@jamiehenson
chore: migrate sidebar YAML data to JSON
105b159
@jamiehenson
chore: remove ProductNavigation assets
d6f7210
@jamiehenson
chore: reorganise nav data assets into higher level construct
512c4b5
@jamiehenson
chore: phase out maps/language stuff
93911df
@jamiehenson
chore: phase out api references YAML representation
6ff115f
@jamiehenson
chore: update ably-ui to 15.1.4, remove clsx
c8d2c60
@jamiehenson
feat: add simplified LeftSidebar and RightSidebar components
d24c0cd
chore: tidy up bar styling
fix: use Gatsby-supported window object and generate snapshots
fix: fix label returns in languageLabel helper
chore: remove LanguageDropdownSelector
fix: populate github edit link on right sidebar
@jamiehenson
chore: move LeftSidebar and RightSidebar to /layout folder
a94fc62
@jamiehenson
chore: remove SidebarContext and prop usage
528517c
@jamiehenson
feat: add LayoutContext, misc state fixes
6b9abb4
@jamiehenson
fix: use Gatsby link with LanguageDropdown
bf31b2b
@aralovelace
aralovelace changed the base branch from web-4082-docs-nav-redesign to mainDecember 17, 2024 09:55
jamiehensonand others added 11 commits December 17, 2024 10:54
@jamiehenson
chore: LanguageDropdown to LanguageSelector, add activePage to context
42d5e70
@jamiehenson
chore: combine activePage data in LayoutContext
3fadfb1
@dependabotApril Smith
chore(deps): bump micromatch in /examples/spaces-live-cursors/react
1cfa6b2
Bumps [micromatch](https://github.com/micromatch/micromatch) from 4.0.7 to 4.0.8.
- [Release notes](https://github.com/micromatch/micromatch/releases)
- [Changelog](https://github.com/micromatch/micromatch/blob/master/CHANGELOG.md)
- [Commits](micromatch/micromatch@4.0.7...4.0.8)
---
updated-dependencies:
- dependency-name: micromatch
dependency-type: indirect
...
Signed-off-by: dependabot[bot] <support@github.com>
@jamiehensonApril Smith
chore: migrate sidebar YAML data to JSON
93b0cce
@jamiehensonApril Smith
chore: reorganise nav data assets into higher level construct
8aa3e48
@jamiehensonApril Smith
feat: add simplified LeftSidebar and RightSidebar components
ea2b330
chore: tidy up bar styling
fix: use Gatsby-supported window object and generate snapshots
fix: fix label returns in languageLabel helper
chore: remove LanguageDropdownSelector
fix: populate github edit link on right sidebar
@jamiehensonApril Smith
chore: move LeftSidebar and RightSidebar to /layout folder
4b6e449
April Smith
chore: update snapshots and fix announcement import directory
ade26d4
April Smith
feature: Revised footer design
b52fc2f
chore: update package with added icons
fix: CoderrabitAI feedback, change a insted of Link and key should be label
April Smith
wip: footer positioning depends on the layout of the page
2c4765c
April Smith
chore: convert footer yaml to json
0225fc5
@aralovelace
aralovelace changed the base branch from main to web-3926-sidebar-refactoringDecember 18, 2024 10:28
@jamiehenson
jamiehensonforce-pushed the web-3926-sidebar-refactoring branch 3 times, most recently from 8f16dd3 to 253f745CompareDecember 20, 2024 12:44
@jamiehenson
jamiehenson removed their request for review January 6, 2025 11:25
@jamiehenson
jamiehensonforce-pushed the web-3926-sidebar-refactoring branch from 6b88581 to d38be4dCompareJanuary 6, 2025 15:47
@jamiehenson
jamiehenson changed the base branch from web-3926-sidebar-refactoring to web-4082-docs-nav-redesignJanuary 6, 2025 16:27
@jamiehenson
jamiehensonforce-pushed the web-4082-docs-nav-redesign branch from 7ef489e to 146ad0fCompareJanuary 9, 2025 12:52
@jamiehenson

jamiehenson commented Jan 9, 2025

Copy link
Copy Markdown
Member

Closing as the work has been picked up in this branch #2374

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@aralovelacearalovelace

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aralovelace@jamiehenson@ably-ci