(DOCSP-11147): Initted Realm Electron Quickstart Doc #494
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cbush
requested changes
Oct 2, 2020
There was a problem hiding this comment.
Good work! I think the layout of the doc is pretty good. Research seems thorough and I think people will get good use out of it.
I went ahead and added a ton of suggestions to save you some time on some punctuation fixes. Please ask if you have any questions about my suggestions.
What needs to change:
- Please accept suggestions.
- Please move the code snippets into literalincludes. This is going to happen soon anyway so let's save ourselves the tech debt.
- Please move the setup headers into a subsection specifically for setup. I'm concerned the "Working Realm Using Renderer and Main Processes" section is getting lost otherwise.
- Please add a note or paragraph or sentence near the top that helps people decide which of the setup sections to read. You could also have a sentence in each setup section that lets people know whether they should read that section or if they can skip it. It's not clear from the section titles alone right now.
- Please write a summary section.
Thanks!
source/includes/steps-realm-with-electron-using-create-react-app.yaml
Outdated
Show resolved
Hide resolved
source/includes/steps-realm-with-electron-using-create-react-app.yaml
Outdated
Show resolved
Hide resolved
| Add the following code to a new file called ``electron.js`` in the | ||
| ``public`` directory: | ||
|
|
||
| .. code-block:: javascript |
There was a problem hiding this comment.
Can you move this to a literalinclude?
source/includes/steps-realm-with-electron-using-create-react-app.yaml
Outdated
Show resolved
Hide resolved
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
|
@cbush per your top level comment ("Please accept suggestions.
|
added 2 commits
October 5, 2020 14:00
…ngomoe/docs-realm into DOCSP-11147-Realm-Electron-QuickStart
Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
mohammadhunan-dev
changed the title
cbush
approved these changes
Oct 6, 2020
source/includes/steps-realm-with-electron-using-create-react-app.yaml
Outdated
Show resolved
Hide resolved
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
…pp.yaml Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Co-authored-by: Chris Bush <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
Issue JIRA link:
https://jira.mongodb.org/browse/DOCSP-11147
Docs staging link (requires sign-in on MongoDB Corp SSO):
https://docs-mongodbcom-staging.corp.mongodb.com/realm/mohammad.hunan/DOCSP-11147-Realm-Electron-QuickStart/node/electron.html