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

feat: add deep outline #265

Merged
merged 1 commit into from
Nov 15, 2023
Merged

feat: add deep outline #265

merged 1 commit into from
Nov 15, 2023

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Nov 14, 2023

Overview

Matches the same feature on celestia docs

https://github.com/celestiaorg/docs/pull/1218/files

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated the theme outline configuration to provide a more detailed documentation structure.

@jcstein jcstein requested a review from MSevey November 14, 2023 21:49
Copy link
Contributor

coderabbitai bot commented Nov 14, 2023

Walkthrough

The recent update involves a modification to the Vitepress configuration, specifically enhancing the theme outline by setting its level to "deep." This change suggests a more detailed table of contents or document structure within the Vitepress project.

Changes

File Change Summary
.../vitepress/config.ts Set theme outline level to "deep"

🐇🍂 In the brisk autumn breeze,
Code lines shuffle with ease.
Deep outlines grow, knowledge flows,
As the doc tree, it now shows. 📚🌟


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

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 ab64843 and a3a541c.
Files selected for processing (1)
  • .vitepress/config.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • .vitepress/config.ts

Copy link
Contributor

github-actions bot commented Nov 14, 2023

PR Preview Action v1.4.4
Preview removed because the pull request was closed.
2023-11-15 14:46 UTC

@jcstein jcstein self-assigned this Nov 14, 2023
@jcstein jcstein requested a review from nashqueue November 15, 2023 14:07
@nashqueue nashqueue merged commit a561b62 into main Nov 15, 2023
2 checks passed
@nashqueue nashqueue deleted the jcs/deep-outline branch November 15, 2023 14:45
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.

2 participants