Skip to content

Commit 0588fcb

Browse files
authored
Some quick polish of getting started page (#1508)
This page is really outdated and really bad, just making some quick edits to remove the worst.
1 parent 0ed62a1 commit 0588fcb

1 file changed

Lines changed: 33 additions & 46 deletions

File tree

docs/getting-started/index.mdx

Lines changed: 33 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Getting Started
22

33
<p className="subtitle">
4-
{' '}
5-
This page will help you learn and understand about Sourcegraph and how to use
6-
it.{' '}
4+
This page will help you learn and understand about Sourcegraph and how to
5+
use it.
76
</p>
87

98
## What is Sourcegraph?
@@ -16,8 +15,8 @@ In addition to the [companies listed on about.sourcegraph.com](https://about.sou
1615

1716
More specifically, Sourcegraph is great for all developers except:
1817

19-
- those on smaller teams with a small amount of code
20-
- those who rarely search, read, or review code
18+
- those on smaller teams with a small amount of code
19+
- those who rarely search, read, or review code
2120

2221
## Why do I need Code Search?
2322

@@ -27,26 +26,26 @@ Facebook and Google provide their employees with an in-house Sourcegraph-like co
2726

2827
Sourcegraph helps you:
2928

30-
- Find example code
31-
- Explore/read code (including during a code review)
32-
- Debug issues
33-
- Locate a specific piece of code
34-
- Determine the impact of changes
35-
- And more!
29+
- Find example code
30+
- Explore/read code (including during a code review)
31+
- Debug issues
32+
- Locate a specific piece of code
33+
- Determine the impact of changes
34+
- And more!
3635

3736
Sourcegraph makes it easier for you and everyone else in your organization to perform these tasks.
3837

3938
## What does Sourcegraph do?
4039

4140
Sourcegraph's main features are:
4241

43-
- [Code navigation](#code-navigation): jump-to-definition, find references, and other smart, IDE-like code browsing features on any branch, commit, or PR/code review
44-
- [Code search](#code-search): fast, up-to-date, and scalable, with regexp support on any branch or commit without an indexing delay (and diff search)
45-
- [Notebooks](#notebooks): pair code and markdown to create powerful live and persistent documentation
46-
- [Cody](#cody): read and write code with the help of a context-aware AI code assistant
47-
- [Code Insights](#code-insights): reveal high-level information about your codebase at its current state and over time to track migrations, version usage, vulnerability remediation, ownership, and anything else you can search in Sourcegraph
48-
- [Batch Changes](#batch-changes): make large-scale code changes across many repositories and code hosts
49-
- [Integrations](#integrations) with code hosts, code review tools, editors, web browsers, etc.
42+
- [Deep Search](/deep-search): Agentic, deep understanding of even the largest code bases.
43+
- [Code Search](#code-search): fast, up-to-date, and scalable, with regexp support on any branch or commit without an indexing delay (and diff search)
44+
- [Code navigation](#code-navigation): jump-to-definition, find references, and other smart, IDE-like code browsing features on any branch, commit, or PR/code review
45+
- [Cody](#cody): read and write code with the help of a context-aware AI code assistant
46+
- [Code Insights](#code-insights): reveal high-level information about your codebase at its current state and over time to track migrations, version usage, vulnerability remediation, ownership, and anything else you can search in Sourcegraph
47+
- [Batch Changes](#batch-changes): make large-scale code changes across many repositories and code hosts
48+
- [Integrations](#integrations) with code hosts, code review tools, editors, web browsers, etc.
5049

5150
## How do I start using Sourcegraph?
5251

@@ -63,44 +62,44 @@ Sourcegraph Enterprise is Sourcegraph's primary offering and includes all code i
6362

6463
## How is Sourcegraph different from the GitHub code search?
6564

66-
- [See how GitHub code search compares to Sourcegraph](/getting-started/github-vs-sourcegraph)
65+
- [See how GitHub code search compares to Sourcegraph](/getting-started/github-vs-sourcegraph)
6766

6867
## Code Search
6968

7069
Sourcegraph code search is fast, works across all your repositories at any commit, and has minimal indexing delay. Code search also includes advanced features, including:
7170

72-
- [Powerful, flexible query syntax](/code-search/queries)
73-
- [Commit diff search](/code-search/features#commit-diff-search)
74-
- [Commit message search](/code-search/features#commit-message-search)
75-
- [Saved search scopes](/code-search/features#search-scopes)
76-
- [Search contexts to search across a set of repositories at specific revisions](/code-search/features#search-contexts)
77-
- [Saved search monitoring](/code-monitoring/)
71+
- [Powerful, flexible query syntax](/code-search/queries)
72+
- [Commit diff search](/code-search/features#commit-diff-search)
73+
- [Commit message search](/code-search/features#commit-message-search)
74+
- [Saved search scopes](/code-search/features#search-scopes)
75+
- [Search contexts to search across a set of repositories at specific revisions](/code-search/features#search-contexts)
76+
- [Saved search monitoring](/code-monitoring/)
7877

7978
Read the [code search documentation](/code-search/) to learn more and discover the complete feature set. Here's a video to help you get started:
8079

81-
- [How to Search commits and diffs with Sourcegraph](https://youtu.be/w-RrDz9hyGI)
82-
- [Search Examples](https://sourcegraph.github.io/sourcegraph-search-examples/)
80+
- [How to Search commits and diffs with Sourcegraph](https://youtu.be/w-RrDz9hyGI)
81+
- [Search Examples](https://sourcegraph.github.io/sourcegraph-search-examples/)
8382

8483
## Code Navigation
8584

8685
Sourcegraph gives your development team cross-repository IDE-like features on your code:
8786

88-
- Hover tooltips
89-
- Go-to-definition
90-
- Find references
91-
- Symbol search
87+
- Hover tooltips
88+
- Go-to-definition
89+
- Find references
90+
- Symbol search
9291

9392
Sourcegraph gives you code navigation in:
9493

95-
- **code files in Sourcegraph's web UI**
94+
- **code files in Sourcegraph's web UI**
9695

9796
![Hover tooltip](https://storage.googleapis.com/sourcegraph-assets/code-graph/docs/hover-tooltip.png)
9897

99-
- **diffs in your code review tool**, via [integrations](/integration/)
98+
- **diffs in your code review tool**, via [integrations](/integration/)
10099

101100
![GitHub pull request integration](https://storage.googleapis.com/sourcegraph-assets/code-graph/docs/github-pr.png)
102101

103-
- **code files on your code host**, via [integrations](/integration/)
102+
- **code files on your code host**, via [integrations](/integration/)
104103

105104
![GitHub file integration](https://storage.googleapis.com/sourcegraph-assets/code-graph/docs/github-file.png)
106105

@@ -112,26 +111,14 @@ Cody is an AI code assistant that uses Sourcegraph code search, the code graph,
112111

113112
[Learn more about Cody](/cody/).
114113

115-
## Notebooks
116-
117-
<Callout type="note">GA in version 3.39 or later</Callout>
118-
119-
Increase dev collaboration and self-service through live documentation covering best practices, shared code, and processes.
120-
121-
Read the [Notebooks documentation](/notebooks/) to learn more, and check out these [publicly available notebooks](https://sourcegraph.com/notebooks?_ga=2.9922293.1906238367.1667257632-528424761.1615652680&_gl=1*1xalma3*_ga*NTI4NDI0NzYxLjE2MTU2NTI2ODA.*_ga_E82CCDYYS1*MTY2NzI1NzYzMi41NS4xLjE2NjcyNjA3NjIuMC4wLjA.).
122-
123114
## Batch Changes
124115

125-
<Callout type="info">Batch Changes is an Enterprise feature.</Callout>
126-
127116
Automate changes to your codebase. Reduce effort, reduce errors, and enable developers to focus on high-value work.
128117

129118
Read the [batch changes documentation](/batch-changes/) to learn more, including helpful how-to guides. Want a video tutorial? Check out this [batch change tutorial](https://www.youtube.com/watch?v=eOmiyXIWTCw)
130119

131120
## Code Insights
132121

133-
<Callout type="info">Code Insights is an Enterprise feature.</Callout>
134-
135122
Sourcegraph lets you understand and analyze code trends by visualizing how the codebase changes. Measure and act on engineering goals such as migration and component deprecation.
136123

137124
Read the [code insights documentation](/code-insights/) to learn more, including helpful how-to guides.

0 commit comments

Comments
 (0)