Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

cody: update readme with more info for user #49846

Merged
merged 12 commits into from
Mar 22, 2023
Merged

cody: update readme with more info for user #49846

merged 12 commits into from
Mar 22, 2023

Conversation

abeatrix
Copy link
Contributor

@abeatrix abeatrix commented Mar 22, 2023

  1. Add more context to README.md. The introduction was generated by Claude so feel free to change it as you see fit.

Marketplace intro:

image

  1. Also updated the BETA tag to experimental as per https://sourcegraph.slack.com/archives/C04NPH6SZMW/p1679500800430569?thread_ts=1679500061.813439&cid=C04NPH6SZMW

image

Test plan

Docs update

See https://github.com/sourcegraph/sourcegraph/tree/bee/cody-docs/client/cody for result page.

App preview:

Check out the client app preview documentation to learn more.

@cla-bot cla-bot bot added the cla-signed label Mar 22, 2023
@abeatrix abeatrix requested a review from novoselrok March 22, 2023 14:48
@abeatrix abeatrix changed the title update docs cody: update readme with more info for user Mar 22, 2023
@github-advanced-security
Copy link

You have successfully added a new SonarCloud configuration ``. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

@abeatrix abeatrix requested a review from beyang March 22, 2023 16:11
"version": "0.0.6",
"publisher": "sourcegraph",
"publisher": "Sourcegraph",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be lowercase? It is in client/vscode/package.json.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we update it to lowercase, the publish name will also be lower case in marketplace it seems, which is different than our vs code extension preview 🤔
image
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it'll be different once we actually publish it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe! Should i revert it back to lowercase for now?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably, just in case it is case-sensitive.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

| Setting | Description | Example |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| cody.enabled | Enable or disable Cody. | true/false |
| cody.serverEndpoint | URL of the Sourcegraph instance. | "https://<instance>.sourcegraph.com" |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll have to remove < and >. Otherwise, Markdown considers this an HTML element.

@abeatrix abeatrix merged commit 3c3b276 into cody-main Mar 22, 2023
@abeatrix abeatrix deleted the bee/cody-docs branch March 22, 2023 17:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants