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

Docs working branch for the v6.0 release #893

Merged
merged 19 commits into from
Jan 29, 2025
Merged

Conversation

MaedahBatool
Copy link
Collaborator

@MaedahBatool MaedahBatool commented Jan 13, 2025

This is the docs working branch for next release.

  • Updated logos and icons
  • @-mention prompts
  • Sourcegraph Analytics
  • Auto-edit docs
  • Brand refresh
  • New tier callouts
  • Agentic chat docs
  • Pricing docs
  • Chat docs
  • Query Types docs
  • Replace outdated screenshots

Copy link

vercel bot commented Jan 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2025 1:49pm

@MaedahBatool MaedahBatool self-assigned this Jan 13, 2025
@MaedahBatool MaedahBatool added the documentation Improvements or additions to documentation label Jan 13, 2025
bahrmichael and others added 2 commits January 23, 2025 09:44
Docs update

Closes SRCH-1561

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.

---------

Co-authored-by: Zahid Ali <[email protected]>
Co-authored-by: Maedah Batool <[email protected]>
Co-authored-by: Anish Lakhwara <[email protected]>
Co-authored-by: Michael Lin <[email protected]>
Co-authored-by: Varun Gandhi <[email protected]>
Co-authored-by: Justin Dorfman <[email protected]>
dadlerj and others added 3 commits January 27, 2025 10:01
This PR will refresh our analytics docs for admins. This centralizes all
customer-facing analytics content into a single, top-level product
section, and describes the future structure of our analytics (cloud vs.
self-hosted).

While these docs still have a lot of blanks, and don't perfectly reflect
the current reality (e.g. "Cody Analytics" hasn't become "Sourcegraph
Analytics" yet; the self-hosted analytics product isn't available in GA
yet; etc.), it's a better setup than what we currently have and is a
format we can build on in the coming months.

Please call out any gaps or issues you see here.

I use screenshots from the current cody analytics product and from the
offsite grafana product

<img width="732" alt="image"
src="https://github.com/user-attachments/assets/69a80595-962f-4433-9882-20506f472d0c">

<img width="781" alt="image"
src="https://github.com/user-attachments/assets/8856079c-dc99-468a-95e8-ff3d727c846e">

-Preview:
https://sourcegraph-docs-git-analytics-docs-5e5d08-sourcegraph-f8c71130.vercel.app/docs/analytics

---------

Co-authored-by: Dan Adler <[email protected]>
Co-authored-by: Jacob Pleiness <[email protected]>
Co-authored-by: Maedah Batool <[email protected]>
Co-authored-by: Petri-Johan Last <[email protected]>
Replace and update icons for SG logo files in callouts components.

---------

Co-authored-by: Jacob Pleiness <[email protected]>
Co-authored-by: Marc <[email protected]>
MaedahBatool and others added 2 commits January 28, 2025 22:59
Docs for auto-edit

- Preview:
https://sourcegraph-docs-git-auto-edits-docs-sourcegraph-f8c71130.vercel.app/docs/cody/capabilities/auto-edit

---------

Co-authored-by: Justin Dorfman <[email protected]>
Co-authored-by: Justin Dorfman <[email protected]>
Co-authored-by: Valery Bugakov <[email protected]>
Co-authored-by: Aravind Ramaraju <[email protected]>
This PR includes the following updates:  

1. **UI Updates**:  
   - Modified the UI to align with the new design.  

2. **TierCallout Component**:  
   - Introduced a new `TierCallout` component for `.mdx` files.  
   - Example usage:  
     ```jsx
     <TierCallout>
Visit the [pricing page](https://about.sourcegraph.com/pricing) for
up-to-date pricing.
       <user>
This feature is available for Enterprise users with [premium
support](https://about.sourcegraph.com/support).
       </user>
     </TierCallout>
     ```  

3. **New Layout Component**:  
- Added a new component inside `Layout` featuring tabs and a video
container.
- Included demo content for now, which will be updated based on
instructions.

---------

Co-authored-by: Maedah Batool <[email protected]>
Co-authored-by: Jacob Pleiness <[email protected]>
Co-authored-by: Marc <[email protected]>
MaedahBatool and others added 3 commits January 28, 2025 23:14
Docs for Agentic chat experience (Deep Cody).

Preview URL:
https://sourcegraph-docs-git-deep-cody-docs-sourcegraph-f8c71130.vercel.app/docs/cody/capabilities/deep-cody

---------

Co-authored-by: Beatrix <[email protected]>
Co-authored-by: graceshih-sg <[email protected]>
Co-authored-by: Aravind Ramaraju <[email protected]>
Co-authored-by: Jacob Pleiness <[email protected]>
Co-authored-by: Marc <[email protected]>
Updating to new screenshot

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
@MaedahBatool MaedahBatool merged commit 1e755c3 into main Jan 29, 2025
5 checks passed
@MaedahBatool MaedahBatool deleted the sg-next-jan1-2025 branch January 29, 2025 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants