docs: README updates VSCODE-395 #516
Conversation
resources/screenshots/playground.png
Outdated
There was a problem hiding this comment.
Do we want to use the use the db.getCollection('collection_name').aggregate([... format here in the future?
We use it in the default template:
#470 (comment)
Since the gifs are already made if it's a lot of time to remake them maybe it's not worth updating.
There was a problem hiding this comment.
I prefer not to redo the gifs 😄
|
|
||
| - Prototype your queries, aggregations, and MongoDB commands with convenient syntax highlighting and intelligent autocomplete for MongoDB shell API, BSON types, MQL operators, aggregation stage snippets, system variables, and for database, collection, and field names. | ||
| - Prototype your queries, aggregations, and MongoDB commands with convenient syntax highlighting and intelligent autocomplete for MongoDB Shell API, BSON types, MongoDB Query API, system variables, and for database, collection, and field names. | ||
| - Run your playgrounds and see the results instantly. Click the play button in the tab bar to see the output. |
There was a problem hiding this comment.
Do we want maybe to mention a shortcut here as well? We have only two of them to run all and to run partial lines of a playground. From time to time people open GitHub issues about shortcuts, so we could list them for clarity. We could also say that they can reassign shortcuts according to their preferences by opening Settings... -> Keyboars Shortcuts, checking the currently available shortcuts, searching for the command they want to assign a shortcut to, and picking the shortcut for it.
There was a problem hiding this comment.
As an alternative, we could move the shortcuts list to a separate section and show them in a table view as you did for settings.
README.md
Outdated
|
|
||
|  | ||
|
|
||
| | Setting | Description | Default | |
There was a problem hiding this comment.
Maybe we could reformat the table to optimize the columns' width. The text is squished in the middle row.
There was a problem hiding this comment.
Column width is not easy to control in markdown tables. Let me see how it looks if I add a new line for the longer settings.
Co-authored-by: Rhys <[email protected]>
Co-authored-by: Alena Khineika <[email protected]>
|
I think because of gif files the bundle size has grown significantly from the expected max 7000000 bytes, it got 10718906. Should we store them somewhere else maybe? |
|
Those go into the bundle?! Ok, then we should probably store them somewhere else. Any idea where? We could make a gh-pages branch and store them in github pages. Let me think if we have other options. S3 could also be an option but it's not the easiest place to maintain afterwards. |
|
Looking at how the images are served in the marketplace, we should be able to safely exclude the
@alenakhineika can we test that out somehow? |
|
You can also add those to .vscodeignore and they should be excluded from the bundle. |
|
Just have seen your last comment, yes! :) To check you can |
|
Ok cool. And then we keep our fingers crossed and hope the images will be there in the marketplace? |
Looks like most of the extensions about databases use it singular vs plural.
Using HTML on purpose to center the banner. This means I need to use an `img` tag and use the absolute URL because I doubt the marketplace gets it replaced when it's not in markdown. The banner will be visible in the README once the PR is merged.
|
@Anemy if you are cool with this, I'll merge. |
Description
previewflagChecklist
Motivation and Context
Open Questions
Dependents
Types of changes