Skip to content
This repository has been archived by the owner on Sep 27, 2021. It is now read-only.

docs: basic queries #158

Merged
merged 9 commits into from
Sep 25, 2020
Merged

docs: basic queries #158

merged 9 commits into from
Sep 25, 2020

Conversation

vpodlnk
Copy link
Collaborator

@vpodlnk vpodlnk commented Sep 14, 2020

Addresses: #157

In case you wanna look at it now, check out on this branch and perform the following commands

$ cd vuepress
$ yarn docs:dev

@neko-kai
Copy link
Contributor

@vpodlnk
Hmm, building seems to require preinstalled vuepress... Note that you may want to teach github CI to publish the docs during the build so that you don't have to update the microsite manually.

% yarn docs:dev
yarn run v1.22.4
warning package.json: No license field
$ vuepress dev docs
/bin/sh: vuepress: command not found
error Command failed with exit code 127.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

@neko-kai
Copy link
Contributor

Looks great so far! However the DIEffectModule part may become redundant soon, I'm planning to make appropriate module inclusion automatic in 0.11 so user wouldn't need to worry about that (at least to launch D4S)

Also, Concurrent & Timer aren't necessary for d4s itself, and a lot of people don't use http4s or find it confusing - I think it may be a good idea to stick to describing just d4s & strictly necessary libraries that are required to run it, to not overload the user with documentation for all the existing libraries

@vpodlnk
Copy link
Collaborator Author

vpodlnk commented Sep 23, 2020

tion for all the exis

First of all, thank you @neko-kai for your review, I really appreciate you find a time to look at this!
Strongly agree with your comments, but if don't describe roles and plugins, user won't understand how to include D4S to their project. Do you suggest to remove this part at all, or just remove things related to htt4s/ cats-effect like Concurrent & Timer?

@vpodlnk
Copy link
Collaborator Author

vpodlnk commented Sep 23, 2020

@vpodlnk
Hmm, building seems to require preinstalled vuepress... Note that you may want to teach github CI to publish the docs during the build so that you don't have to update the microsite manually.

% yarn docs:dev
yarn run v1.22.4
warning package.json: No license field
$ vuepress dev docs
/bin/sh: vuepress: command not found
error Command failed with exit code 127.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

I have GitHub action for this already, it's just my mistake that I forget to show here that you must install vuepress, sorry 🙈

@neko-kai
Copy link
Contributor

Strongly agree with your comments, but if don't describe roles and plugins, user won't understand how to include D4S to their project. Do you suggest to remove this part at all, or just remove things related to htt4s/ cats-effect like Concurrent & Timer?

Just the second part with http4s, Concurrent & Timer. Neither http4s nor cats-effect are required for understanding or using the library itself...

@vpodlnk
Copy link
Collaborator Author

vpodlnk commented Sep 23, 2020

Strongly agree with your comments, but if don't describe roles and plugins, user won't understand how to include D4S to their project. Do you suggest to remove this part at all, or just remove things related to htt4s/ cats-effect like Concurrent & Timer?

Just the second part with http4s, Concurrent & Timer. Neither http4s nor cats-effect are required for understanding or using the library itself...

@neko-kai, understood, I'll adjust it. Thanks again for your comments!

@vpodlnk vpodlnk merged commit ba50838 into develop Sep 25, 2020
@vpodlnk vpodlnk deleted the docs-basic-queries branch September 25, 2020 11:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants