[DOCS] Navbar fixes - part 3

[kotAPI]

Summary by CodeRabbit

• New Features
  • Enhanced documentation navigation: The navigation now uses a streamlined, default configuration across all documentation pages, ensuring a more consistent and dynamic display of available sections.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates several aspects of the documentation codebase. The ESLint configuration now disables the enforcement of brace-style conventions. In the layout component, unused props for the Navigation component have been removed. Additionally, a new NavBarContextType has been introduced to improve type safety for the navigation bar context. Finally, the Navigation component’s logic is modified to update sections based on a substring match within the current pathname.

Changes

File(s)	Change Summary
docs/.eslintrc.json	Added a new ESLint rule that disables "brace-style" while retaining the "no-tabs": "off" rule.
docs/app/docs/layout.tsx, docs/components/navigation/Navigation.tsx	Removed unused props from the Navigation component in the layout and updated the useEffect condition to check for the substring "/docs/" in the pathname.
docs/components/Main/NavBar/NavBarContext.tsx	Introduced a new type NavBarContextType and updated createContext to include default values for improved type safety.

Sequence Diagram(s)

sequenceDiagram
  participant U as User
  participant N as Navigation Component
  participant E as useEffect Hook

  U->>N: Navigates to a new route
  N->>E: Triggers useEffect with updated pathname
  alt Pathname includes "/docs/"
      E->>N: setSections(docsSections)
  else
      E->>N: setSections(defaultSections)
  end

Loading

Possibly related PRs

• Fix broken nav on mobile and desktop #899: Involved in removing Navigation component props in a similar context, affecting how Navigation is configured.
• Resolve Unused Packages + Linting #864: Related to modifications in linting configurations, specifically around ESLint rule management.

Suggested labels

automerge

Suggested reviewers

• GoldGroove06

Poem

I'm a rabbit in the code field bright,
Hopping 'round lint rules through the night.
Props have hopped away, context now takes flight,
Navigation paths gleam with a brand new light.
With joyful leaps, I cheer these updates in sight!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/app/docs/layout.tsx

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/components/navigation/Navigation.tsx

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/components/Main/NavBar/NavBarContext.tsx

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 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 2743e47 and 8542da2.

📒 Files selected for processing (4)

• docs/.eslintrc.json (1 hunks)
• docs/app/docs/layout.tsx (1 hunks)
• docs/components/Main/NavBar/NavBarContext.tsx (1 hunks)
• docs/components/navigation/Navigation.tsx (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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