-
Notifications
You must be signed in to change notification settings - Fork 30
refactor(docs): reorganize navigation structure #155
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
Merged
+466
−164
Merged
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
10fb904
refactor(docs): reorganize navigation structure
tyaga001 f55f85c
docs: restructure sidebar with improved navigation
tyaga001 a2f1a50
fix(docs): resolve markdown linting errors in quickstart guide
tyaga001 18f4d27
docs: remove redundant tip from FAQ
tyaga001 afd138a
docs: remove redundant tip from FAQ
tyaga001 8d4f248
docs: removed extra parenthesis
tyaga001 3e7190a
docs: removed extra space
tyaga001 4526881
docs: removed extra space
tyaga001 5cfcff4
docs: simplify getting started list structure
tyaga001 4b123bc
docs: simplify getting started list structure
tyaga001 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
label: About | ||
position: 2 | ||
label: Platform | ||
position: 8 | ||
collapsible: true | ||
collapsed: true | ||
collapsed: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
label: Getting Started | ||
position: 2 | ||
collapsible: true | ||
collapsed: false |
2 changes: 1 addition & 1 deletion
2
docs/configure-coderabbit.md → docs/getting-started/configure-coderabbit.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: Playing with CodeRabbit | ||
sidebar_label: Quickstart | ||
description: Get started with CodeRabbit in less than 2 minutes | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Quickstart Guide | ||
|
||
:::note | ||
Get started with CodeRabbit in three simple steps. No complex configuration needed. | ||
::: | ||
|
||
## Steps to Enable CodeRabbit | ||
|
||
### Sign In with GitHub | ||
|
||
- Visit [coderabbit.ai](https://coderabbit.ai) | ||
- Click "Sign in with GitHub" | ||
- Authorize CodeRabbit | ||
|
||
 | ||
tyaga001 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Add Your Repository | ||
|
||
- Go to your [Dashboard](https://app.coderabbit.ai/dashboard) | ||
- Click "Add Repositories" | ||
- Select the repositories you want to enable | ||
|
||
 | ||
|
||
### You're Done 🎉 | ||
|
||
- CodeRabbit will automatically start reviewing your Pull Requests | ||
- Default configuration works out of the box | ||
- No additional setup needed | ||
|
||
## What's Next? | ||
|
||
- Watch CodeRabbit review your next PR automatically | ||
|
||
Here's an example of CodeRabbit in action: | ||
|
||
 | ||
|
||
[View live example PR](https://github.com/tyaga001/devtoolsacademy/pull/39) | ||
|
||
- [Configure CodeRabbit](/getting-started/configure-coderabbit) (optional) | ||
- [Add custom review instructions](/guides/review-instructions) (optional) | ||
tyaga001 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Need Help? | ||
|
||
- Join our [Discord community](https://discord.gg/coderabbit) for support | ||
- Check out our [FAQ](/faq) | ||
- Contact [[email protected]](mailto:[email protected]) | ||
|
||
:::tip | ||
CodeRabbit starts working immediately. You can customize its behavior later when needed. | ||
::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
label: Guides | ||
position: 6 | ||
position: 5 | ||
collapsible: true | ||
collapsed: true | ||
collapsed: false |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
label: Integrations | ||
position: 7 | ||
collapsible: true | ||
collapsed: true | ||
collapsed: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
label: Overview | ||
position: 1 | ||
collapsible: true | ||
collapsed: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.