docs: clarify how to open SourceMeta Studio panel #135
Conversation
Signed-off-by: EncrypterParv <[email protected]>
README.markdown
Outdated
|
|
||
|  | ||
|
|
||
| Opening SourceMeta Studio |
There was a problem hiding this comment.
Please say Sourcemeta (like we do in other parts of this README even) and not SourceMeta
README.markdown
Outdated
| After installing the SourceMeta Studio extension, issues are not shown automatically when opening a JSON file. | ||
| You must open the SourceMeta Studio panel manually. | ||
|
|
||
| Option 1: Editor Title Bar |
There was a problem hiding this comment.
I think we can focus on this option, as it's the main one people will use. More advanced users will figure out the command palette by themselves. And I think you can just transform all of it into 1 paragraph, to keep it short and concise
README.markdown
Outdated
| 1. Open any JSON or YAML file. | ||
| 2. Click the SourceMeta Studio icon in the editor title bar. | ||
| 3. The SourceMeta Studio panel will open for the active file. | ||
|  |
There was a problem hiding this comment.
Can we have a better file name? The current one is terrible. Also you have to install it using Makefile for it to render in the marketplace
Signed-off-by: EncrypterParv <[email protected]>
There was a problem hiding this comment.
Maybe let's call it instructions.png?
README.markdown
Outdated
|
|
||
|  | ||
|
|
||
| Opening Sourcemeta Studio |
There was a problem hiding this comment.
I think we can remove this line
README.markdown
Outdated
|
|
||
| Opening Sourcemeta Studio | ||
|
|
||
| After installing the Sourcemeta Studio extension, issues are not shown automatically when opening a JSON file. |
There was a problem hiding this comment.
| After installing the Sourcemeta Studio extension, issues are not shown automatically when opening a JSON file. | |
| After installing the Sourcemeta Studio extension, the user interface is not shown automatically when opening a JSON Schema file. |
README.markdown
Outdated
| Opening Sourcemeta Studio | ||
|
|
||
| After installing the Sourcemeta Studio extension, issues are not shown automatically when opening a JSON file. | ||
| You must open the Sourcemeta Studio panel manually. |
There was a problem hiding this comment.
Maybe put this line as another sentence in the paragraph above?
README.markdown
Outdated
| After installing the Sourcemeta Studio extension, issues are not shown automatically when opening a JSON file. | ||
| You must open the Sourcemeta Studio panel manually. | ||
|
|
||
| Open any JSON or YAML file, then click the Sourcemeta Studio icon in the editor title bar. This opens the Sourcemeta Studio panel for the active file. |
There was a problem hiding this comment.
This too. Try to make it all one concise paragraph
|
|
||
|  | ||
|
|
||
|
|
There was a problem hiding this comment.
Applied the changes you asked and commited the following changes, do let me know for any other updates.
Signed-off-by: EncrypterParv <[email protected]>
Makefile
Outdated
| cd vscode && $(NPM) run build | ||
| $(INSTALL) -m 0664 README.markdown build/vscode/README.md | ||
| $(INSTALL) -m 0664 screenshot.png build/vscode/screenshot.png | ||
| $(INSTALL) -m 0664 sourcemeta-studio-icon.png build/vscode/instructions.png |
There was a problem hiding this comment.
I think you need to fix the "from" file name here too?
README.markdown
Outdated
|
|
||
| After installing the Sourcemeta Studio extension, issues are not displayed automatically when you open a JSON or YAML file. To view them, open the file and click the Sourcemeta Studio icon in the editor title bar to manually open the Sourcemeta Studio panel for the active file. | ||
|
|
||
|  |
There was a problem hiding this comment.
|  | |
|  |
There was a problem hiding this comment.
sorry for the mistakes, I have applied your suggestions and commited them, thanks for your support!!.
Signed-off-by: EncrypterParv <[email protected]>
2 participants
Adds brief README instructions explaining how to open the SourceMeta Studio panel
via the editor title bar or Command Palette.
Closes #65