Docs for Sourcegraph Architecture #1067
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
MaedahBatool
added
documentation
| Code Navigation surfaces data (for example, doc comments for a symbol) and actions (for example, go to definition, find references) based on our semantic understanding of code (unlike search, which is completely text-based). | ||
|
|
||
| By default, Sourcegraph provides [search-based code navigation](/code-search/code-navigation/search_based_code_navigation). This reuses all the architecture that makes search fast, but it can result in false positives (for example, finding two definitions for a symbol or references that aren't actually references) or false negatives (for example, not being able to find the definition or all references). | ||
|
|
There was a problem hiding this comment.
No reference to our syntactic-indexing solution here. I don't know how explicitly we want to document this new (beta?) feature but it should probably be mentioned for completeness.
There was a problem hiding this comment.
@loujar, just for confirmation, are you referencing the auto-indexing feature?
docs/admin/architecture.mdx
Outdated
|
|
||
| ## Code insights | ||
|
|
||
| Code insights surface higher-level, aggregated information to leaders in engineering organizations in dashboards. For example, code insights can track the number of matches of a search query over time, the number of code navigation diagnostic warnings in a codebase, or the usage of different programming languages. Sample use cases for this are tracking migrations, the usage of libraries across an organization, tech debt, code base health, and much more. |
There was a problem hiding this comment.
greater question regarding the content of this doc; should we maintain detailed feature descriptions throughout this page? I personally feel that we should link to the respective feature pages for these topics, and have the content focus strictly on the architectural details of the feature.
There was a problem hiding this comment.
I have also been wondering this. Do we think a detailed description of the individual services would be more appropriate, and can reference the impact that has on specific features if applicable?
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
There was a problem hiding this comment.
I think first and foremost we need to determine if this doc, in current format, contains the appropriate information. In current state it highlights individual features, but in reality I think it's be more useful to document what each individual service within the architecture diagram does, with links to applicable features.
This page has no reference to Cody or Cody Architecture, which needs to be fixed.
I would also want validation from someone on Eng that this is a comprehensive diagram of our Services. With this diagram being as old as it is, I'd hate to release something that has since become inaccurate.
Co-authored-by: Andrew Norrish <110418926+anorrish@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
|
Hey @loujar, to unblock the rest of the team. I am making this PR live. All the remaining feedback I'll tackle in a separate PR. Plus I have added details about the Cody's architecture as well. :) |
Move Sourcegraph Architecture docs from the legacy site to the main site.