Update documentation framework with docusaurus #506
Conversation
This file contains 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
* Correct project example of Tuple * add myself to contributors
* Adding CONTRIBUTING.md * Initial coding standards * Spacing and line-break updates * Updated coding standards with new structure/examples * Further review updates
* add bichain to Either and Result * update Async bichain specs * clean up existing code a wee bit * add links and bodys for all dem bichains * add bichain to Maybe * update doc examples
in the docs the property num had the same type as the example above. the change makes clear the contramap is not working on a different property instead of the type
* Edit README (evilsoft#454) - reorganize titles - add documentation references - add extra example * Edit docs/functions/helpers.md#curry - add `curry` examples - show use of curried functions with different combinations of parameters - add `curry` examples with optional parameters - show possibly unexpected edge cases * Make requested changes - Use references instead of links in README - Change the way optional parameters are warned against - Conform to style in force - Reserve comments above definitions for signatures - Reserve first comment after function call for results - Add textual explanation of the return type of `curry` * Add requested changes - update README to adhere to coding standards - update `curry` docs - remove five input example - rename three input example - add definition to three input example - add definition to data - use double quotes for returned strings - reword caveat about optional parameters * Remove superfluous `.map()` from examples * Add sunwukonga as doc contributor
- `divide` and `safeDivide`
In case of a Left the object is added as the value of error instead of the value of the property 'a' transferred to 'error'
…ft#466) Co-authored-by: Dale Francis <[email protected]>
* update deps * remove git add from lint-staged, no longer needed * remove node:8 from travis, some deps no longer support it
Typo on either definition
Added a new `doc` contributor as @karthikiyengar suggested on this MR evilsoft#469 Thanks :) Co-authored-by: Dale Francis <[email protected]>
Fix typo Co-authored-by: Dale Francis <[email protected]>
…t#475) * Allow fn passed to Async.fromPromise to be partially applied * Update docs to reflect changes to Async.fromPromise currying its input * Update contributors
* Update CONTRIBUTORS.md Adding in instructions on how to add to the list of contributors * Update CONTRIBUTORS.md
Co-authored-by: Dale Francis <[email protected]>
Update import path from 'crocks/Pair/merge' to 'crocks/pointfree/merge'.
* Output result not correct Identity(42) .valueOf() //=> 42 (Must be 42) not 33 Remove following lines Identity(20) .concat(Identity(22)) .valueOf() //=> 35 due to this error message. Throwing error "TypeError: Identity.concat: Both containers must contain Semigroups of the same type" * Addressing PR Comments As discussed apply changes to Identity.md File. * Add Spacing between array values
* Update Import path for 'merge' module-name Update import path for 'merge' module-name from 'crocks/Pair/merge' to 'crocks/pointfree/merge'. * Add name to contributors List
TODO: - Add icons - Working on css style - Add correct font - Integrate reading time? - Search (https://v2.docusaurus.io/docs/search/) - Runkit - Fix scroll (unwanted scroll while switching code/runkit) - Create good layout
|
Gonna give this a Play tonight! Amazing! Quick question why were the comments in the code files changed to |
|
I checked, there is a commit from master in the pull request (I forked the master to get an updated version of code) |
|
Oh gotcha. Sorry I missed that. |
|
I broke CI but there is a warning message in travis: |
|
Not sure how i missed this PR coming in. Can check it out, nice work mate |
|
🎉 CI is 🟢 again |
|
@evilsoft @dalefrancis88 if the PR will be accepted could I submit crocks.dev to docusaurus showcase?
|
|
I'll need to catch up with @evilsoft on this one but this is looking good |
|
Any update on this? |
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.
Update documentation framework #459
How to test:
See PR in action