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

Implement and Improve Landing Page #60

Closed
caldwella2 opened this issue Mar 27, 2021 · 2 comments · Fixed by #76
Closed

Implement and Improve Landing Page #60

caldwella2 opened this issue Mar 27, 2021 · 2 comments · Fixed by #76
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request Team 3 This tag serves as a `claim` for team 3 to work on the issue initially

Comments

@caldwella2
Copy link
Collaborator

caldwella2 commented Mar 27, 2021

Context and feature:
There is no true need to see the instructions of how to run the program if the program is already running. It is repetitive and it does not add anything to the landing page that is needed.

Proposed solution:
We want to create a new landing page to reduce redundancy generated by the README. The new landing page would be a new markdown file and it would display how to use the sample files as an example of how to use files with the program. It also would show quick instructions further explaining how to use the tools provided by GatorMiner.

@caldwella2 caldwella2 added documentation Improvements or additions to documentation enhancement New feature or request Team 3 This tag serves as a `claim` for team 3 to work on the issue initially labels Mar 27, 2021
@enpuyou
Copy link
Contributor

enpuyou commented Mar 27, 2021

@caldwella2 Thanks for proposing the change! I completely agree with you on the current landing page being redundant and unnecessary. Perhaps include instructions on what each analyzer does? Sort of like what #59 is proposing? I think it might be a good idea for your team to reach out so to make sure the contribution it's not overlapping.

@jjumadinova
Copy link
Contributor

Please include more detailed acceptance criteria, an estimate and assign it to a sprint if working on this issue for sprint 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Team 3 This tag serves as a `claim` for team 3 to work on the issue initially
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants