Skip to content

Conversation

@eseliger
Copy link
Member

This PR contains several commits that attempt to do a large-scale cleanup of our docs page to address some common concerns and start out a new information architecture.

Check out the individual commits for a decent review experience.

Highlights:

  • Removed some repetitive and nowadays irrelevant information
  • Code navigation is now a top-level highlight, it's a unique capability of our platform and should not be hidden under Code Search
  • Introduce a separation of /admin and /self-hosted where the latter contains information only relevant to self-hosted customers. This will help ensure that each customer type (cloud, on-prem) will easily understand and only see information relevant to their deployment type.
  • Fix a ton of dead and broken links
  • Unify on - over _ in URL paths, we were very inconsistent here. Backcompat via redirects.
  • Add broken link and underscore in paths detection to build process

Minor things to make docs a bit less repetitive and remove some irrelevant information.
This is a whole product suite, it should not be lost somewhere under code search.
This makes a clean /admin section that applies to all instances, and then a separate /self-hosted section that applies to self-hosted only. This drastically reduces the amount of documentation for Cloud customers.

TODO:

Need to fix up tooling that writes dashboards.mdx and alert_solutions.mdx.
Noticed we're quite inconsistent here. This updates all files and links, and adds redirects to keep this change backwards compatible.
Verify no dead links and no underscores are used in URLs.
@vercel
Copy link

vercel bot commented Dec 14, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
sourcegraph-docs Ready Ready Preview, Comment Dec 14, 2025 10:38pm

Redundant with content in self-hosted section.
@eseliger eseliger marked this pull request as ready for review December 15, 2025 19:18
@eseliger eseliger merged commit fcae82c into main Dec 15, 2025
2 checks passed
@eseliger eseliger deleted the es/cleanup-1214 branch December 15, 2025 19:19
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.

3 participants