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

Readme: Get Started section #33

Merged
merged 8 commits into from
Jul 20, 2022
Merged

Readme: Get Started section #33

merged 8 commits into from
Jul 20, 2022

Conversation

atilafassina
Copy link
Contributor

@atilafassina atilafassina commented Jul 19, 2022 •
edited
Loading

This PR adds a Get Started section to the readme

part of #28

@atilafassina atilafassina added the documentation Improvements or additions to documentation label Jul 19, 2022
@atilafassina atilafassina self-assigned this Jul 19, 2022
@atilafassina atilafassina marked this pull request as ready for review July 19, 2022 19:54
TejasQ
TejasQ reviewed Jul 19, 2022
View reviewed changes
Copy link
Contributor

@TejasQ TejasQ left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks so much for improving this! I included some minor nitpicks along with some bigger issues like missing links and stuff. Please be a bit careful with typos and missing links. 🙌

README.md Outdated Show resolved Hide resolved
README.md

## Gettings started

Once the extension is installed it from the [VS Code Marketplace](), it should show up in your Activity Bar like in the image below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Don’t forget the link. Also re-read this, it seems to not make sense. “Once the extension is installed it from”?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

as far as I know, this link doesn't yet exist. I added it as a placeholder for now.
I can also remove it to not merge a broken link to main, but as far as I understand, we're adding it to the marketplace tomorrow

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah cool, so are we keeping this a draft until we have a link?

Copy link
Contributor

Choose a reason for hiding this comment

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

#35

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Atila and others added 6 commits July 20, 2022 00:01
@atilafassina
docs: add get-started section
c4c51b9
@atilafassina @TejasQ
chore: VSCode to VS Code
1bd00b6 
Co-authored-by: Tejas Kumar <tejas+lol@tejas.qa>
@atilafassina @TejasQ
docs: fix bad paragraph, add link to docs
69d38cd 
Co-authored-by: Tejas Kumar <tejas+lol@tejas.qa>
@atilafassina @TejasQ
chore: fix typos
e26d70f 
Co-authored-by: Tejas Kumar <tejas+lol@tejas.qa>
@atilafassina @TejasQ
chore: capitalize words in titles
8425995 
Co-authored-by: Tejas Kumar <tejas+lol@tejas.qa>
@atilafassina @TejasQ
docs: add intro to Features section
4dcf7bc 
Co-authored-by: Tejas Kumar <tejas+lol@tejas.qa>
fabien0102
fabien0102 approved these changes Jul 20, 2022
View reviewed changes
Copy link
Contributor

@fabien0102 fabien0102 left a comment

Choose a reason for hiding this comment

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

Let's merge this and add the link later 😃

@TejasQ
Copy link
Contributor

TejasQ commented Jul 20, 2022

Is it just me or are these image previews not working? https://github.com/xataio/vscode-extension/blob/4dcf7bceb43f2ad751d0c1980cad3e28c7fbec8c/README.md

image

@fabien0102
Copy link
Contributor

Is it just me or are these image previews not working? https://github.com/xataio/vscode-extension/blob/4dcf7bceb43f2ad751d0c1980cad3e28c7fbec8c/README.md

image

It's not merged yet and this is pointing on main

TejasQ
TejasQ approved these changes Jul 20, 2022
View reviewed changes
Copy link
Contributor

@TejasQ TejasQ left a comment

Choose a reason for hiding this comment

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

I am once again flagging very minor and inconsequential bullshit for "polish", but this is good to go as is of course.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md
Comment on lines +11 to 12
Clicking on any of the **Get Started** buttons should open your default browser. From there, login to your Xata account, and it will prompt you to create an [API key](https://docs.xata.io/concepts/api-keys).

Copy link
Contributor

@TejasQ TejasQ Jul 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Super minor nitpick

Suggested change
Clicking on any of the **Get Started** buttons should open your default browser. From there, login to your Xata account, and it will prompt you to create an [API key](https://docs.xata.io/concepts/api-keys).
Clicking on any of the **Get Started** buttons should open your default browser. From there, login to your Xata account, and it will prompt you to create an [API key](https://docs.xata.io/concepts/api-keys).

TejasQ and others added 2 commits July 20, 2022 11:55
@TejasQ
Fix unchanged paragraphs
d92453f
@fabien0102 @TejasQ
Apply suggestions from code review
bbcde1d 
Co-authored-by: Tejas Kumar <tejas+lol@tejas.qa>
@fabien0102 fabien0102 merged commit 5999a19 into main Jul 20, 2022
@fabien0102 fabien0102 deleted the docs/get-started branch July 20, 2022 14:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@TejasQ TejasQ TejasQ approved these changes

@fabien0102 fabien0102 fabien0102 approved these changes

Assignees

@atilafassina atilafassina

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@atilafassina @TejasQ @fabien0102