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

Issue#33 ~ Documentation Website #89

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open

Issue#33 ~ Documentation Website #89

wants to merge 23 commits into from

Conversation

waryankaa
Copy link
Collaborator

@waryankaa waryankaa commented Apr 20, 2021

For this pull request, we have created a website that will explain the features of GatorMiner

What is the current behavior?

The current behavior is that we have created a website interface and we will continue to work on adding the information about the different parts.

What is the new behavior if this PR is merged?

A new website will be added containing detailed information about the GatorMiner functions.

Close #33

Type of change

Please describe the pull request as one of the following:

  • Bug fix
  • Breaking change
  • New feature
  • Documentation update
  • Other

Other information

This PR has:

  • Commit messages that are correctly formatted
  • Tests for newly introduced code
  • Docstrings for newly introduced code

Developers

@kailaniwoodard @Peter-Snipes @zaethovenn @waryankaa

@codecov
Copy link

codecov bot commented Apr 20, 2021

Codecov Report

Merging #89 (8ef66e1) into master (244b0ba) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #89   +/-   ##
=======================================
  Coverage   92.09%   92.09%           
=======================================
  Files           6        6           
  Lines         253      253           
=======================================
  Hits          233      233           
  Misses         20       20           

Copy link
Contributor

@jjumadinova jjumadinova left a comment

Choose a reason for hiding this comment

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

Please make sure your branch is up to date with the master branch before the reviews.

@enpuyou
Copy link
Contributor

enpuyou commented Apr 20, 2021

Hi @kailaniwoodard, thanks for working on this feature that creates a documentation website for the tool. Before reviewing, I'm just curious if the website is currently being deployed on any platforms? I think it would be easier if reviewers can just go check out the website instead of building and serving it locally.

@kailaniwoodard
Copy link
Collaborator

@enpuyou I'm currently attempting to deploy the website using Netlify as of right now, but I'm having some trouble so right now it's a bit up in the air.

@noorbuchi
Copy link
Collaborator

Hello! Thanks for all the work on this PR. Please let us know if you need any help or if it's ready for review.

@waryankaa
Copy link
Collaborator Author

This PR is ready for review. Thank you

@waryankaa waryankaa requested a review from jjumadinova April 28, 2021 00:04
@waryankaa
Copy link
Collaborator Author

@enpuyou @noorbuchi @corlettim
We are ready for a review. Thank you

@munzekm munzekm self-requested a review April 28, 2021 18:54
@noorbuchi
Copy link
Collaborator

@waryankaa it looks like netlify deployment is failing. Have you been able to figure out why this is happening and if it is feasible to fix it?

* Export code from https://github.com/umdjs/umd/blob/master/returnExports.js
*/
;(function (root, factory) {
if (typeof define === 'function' && define.amd) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Codacy has a fix for the issue: Strings must use doublequote.

Suggested change
if (typeof define === 'function' && define.amd) {
if (typeof define === "function" && define.amd) {

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.

Possible Documentation Website
6 participants