Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discrepancies and Missing Points in the v2.0.0 Quick Start Guide #359

Open
kohtaro24 opened this issue Nov 20, 2024 · 0 comments
Open

Discrepancies and Missing Points in the v2.0.0 Quick Start Guide #359

kohtaro24 opened this issue Nov 20, 2024 · 0 comments

Comments

@kohtaro24
Copy link

The v2.0.0 Quick Start Guide contains a couple of discrepancies and missing details that could lead to confusion for users. Here are the issues I encountered:


1. import { stateSyncEnhancer } from 'electron-redux' does not work

The Quick Start guide for v2.0.0 suggests using the following import:

import { stateSyncEnhancer } from 'electron-redux'

However, this import does not seem to work.

It appears that stateSyncEnhancer is not exported from the top-level electron-redux module. Instead, it is exported from either electron-redux/renderer or electron-redux/main.

To make it work, I had to adjust the import paths as follows:

// For the renderer process
import { stateSyncEnhancer } from 'electron-redux/renderer'

// For the main process
import { stateSyncEnhancer } from 'electron-redux/main'

It might be helpful to clarify the documentation or update the package exports to align with the Quick Start guide. If this is a misunderstanding on my part, I apologize in advance.

2. 'electron-redux/preload' is not mentioned as required

To use electron-redux correctly, it seems necessary to import 'electron-redux/preload' in the preload script.

This important step is not mentioned in the Quick Start Guide. As a result, users following the guide might encounter errors, as I did. Including this requirement in the guide would help prevent such issues.


Thank you for your attention to these points!
I hope this feedback is helpful in improving the documentation for future users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant