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

docs: minor documentation updates and fixes #92

Merged
merged 6 commits into from
Mar 13, 2024

Conversation

kerren
Copy link
Contributor

@kerren kerren commented Mar 10, 2024

I've been reading through the documentation because I'd like to have a holistic understanding of your library when I use it for my next project. I'm really loving this by the way, it's excellent!

I picked up a few issues as well as some things that I think would be useful to specify in the documentation based on the questions I asked when I read them.

I'm happy to remove some changes if you disagree, let's have discussion about them if you need more context!

kerren added 5 commits March 10, 2024 12:29
The BookUI interface had a different key to what was being set in the example code
Given that the plusN function needs to be called, the assumption here is that the plus100 function should also be called as they return the same type
…xample

The reason for this is that it looks like a typo and that it should be a string (based on how ngrx and other libraries do it)
This is the same as the npm command but it allows users to copy and paste more easily
README.md Show resolved Hide resolved
@zuriscript
Copy link
Owner

Thank you very much for checking the docs and your Contribution.
I am very happy to merge it after you have reviewed my comment.

Glad you like the library. We have some cool new features planned for the future.
If you need some more context or insights, I would be totally open to a discussion.

Copy link
Owner

@zuriscript zuriscript left a comment

Choose a reason for hiding this comment

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

Changes look good, only the one docs change in query.md is invalid.

README.md Show resolved Hide resolved
docs/docs/building-blocks/query.md Outdated Show resolved Hide resolved
@kerren
Copy link
Contributor Author

kerren commented Mar 13, 2024

Thank you very much for checking the docs and your Contribution. I am very happy to merge it after you have reviewed my comment.

Glad you like the library. We have some cool new features planned for the future. If you need some more context or insights, I would be totally open to a discussion.

@zuriscript I'd be really keen to get in touch, if there's more I can contribute here from a code perspective, that would be awesome! What's the best way to get in touch?

@zuriscript zuriscript merged commit efc6091 into zuriscript:master Mar 13, 2024
1 check passed
@zuriscript
Copy link
Owner

@kerren Thanks again for your contribution.
If you want to discuss something general about signalstory, you can joust open a thread in the GitHub discussion section.
Alternatively, you can provide your email or contact details via the contact form on my website, and I'll personally reach out to you.

It has been shown that effect objects work very well for structuring and scaling the application. Our upcoming features will primarily focus on enhancing this aspect, including the implementation of a scheduling mechanism for recurring effects and improving interoperability between effects and HTTP calls. New Plugins or plugin ideas are also always welcomed.

@kerren kerren deleted the fix/documentation-corrections branch March 19, 2024 18:31
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

Successfully merging this pull request may close these issues.

2 participants