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

[WEB-3950] Simplified docs routing, port page content from YAML to JSON #2383

Draft
wants to merge 52 commits into
base: web-4082-docs-nav-redesign
Choose a base branch
from

Conversation

jamiehenson
Copy link
Member

@jamiehenson jamiehenson commented Jan 15, 2025

This pull request includes several changes focused on updating configurations, removing outdated content, and improving the codebase for better maintainability. The most important changes include updating the CircleCI configuration, removing old YAML page content, and modifying the build and serve scripts in package.json.

Configuration Updates:

  • Updated the CircleCI Node orb from version 5.2.0 to 5.3.0 in .circleci/config.yml.
  • Removed the test for nginx /docs rewriting in .circleci/config.yml.

Content Removal:

  • Removed outdated YAML page content files for various sections including asset-tracking.yaml, channels.yaml, chat.yaml, homepage.yaml, livesync.yaml, and spaces.yaml. [1] [2] [3] [4] [5] [6]

Codebase Simplification:

  • Removed the gatsby-source-filesystem plugin for yaml-page-content in gatsby-config.ts.
  • Updated the build and serve scripts in package.json to remove the --prefix-paths option.

Code Refactoring:

  • Modified the BodySection component in BodySection.tsx to use ContentSection instead of SectionProps and set a default value for bottomMargin. [1] [2]

These changes aim to streamline the configuration, remove unused content, and improve the overall maintainability of the project.

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
Copy link

coderabbitai bot commented Jan 15, 2025

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.


🪧 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-3950-norm-k6n8uf January 15, 2025 17:13 Inactive
@jamiehenson jamiehenson force-pushed the web-3950-normalised-docs-routing branch from ed97940 to cc77806 Compare January 15, 2025 17:13
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 15, 2025 17:14 Inactive
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 15, 2025 17:31 Inactive
@jamiehenson jamiehenson force-pushed the web-3950-normalised-docs-routing branch from dfb96f0 to 481033c Compare January 15, 2025 17:38
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 15, 2025 17:38 Inactive
@jamiehenson jamiehenson force-pushed the web-3950-normalised-docs-routing branch from 481033c to a830666 Compare January 15, 2025 17:42
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 15, 2025 17:42 Inactive
@jamiehenson jamiehenson force-pushed the web-3950-normalised-docs-routing branch from a830666 to 0443772 Compare January 16, 2025 13:59
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 16, 2025 14:00 Inactive
@jamiehenson jamiehenson changed the title Web 3950 normalised docs routing [WEB-3950] Simplified docs routing, port page content from YAML to JSON Jan 16, 2025
@jamiehenson jamiehenson force-pushed the web-3950-normalised-docs-routing branch from 0443772 to 1478e0c Compare January 16, 2025 14:15
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 16, 2025 14:16 Inactive
@jamiehenson jamiehenson temporarily deployed to ably-docs-web-3950-norm-k6n8uf January 16, 2025 14:29 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants