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.

Sign up for GitHub

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

Jump to bottom

Changes to README file #604

Closed
justin0022 opened this issue Jul 19, 2019 · 4 comments
Closed

Changes to README file #604

justin0022 opened this issue Jul 19, 2019 · 4 comments
Assignees
@justin0022
Labels
📖 documentation Involves updates to the README, CONTRIBUTING, or other supporting text files 📈 enhancement New feature or request 🚧 in progress
Projects
MyLA-Default-Project

Comments

@justin0022
Copy link
Collaborator

The existing README file provides an overview for setting up the project, but doesn't really show its features.

Perhaps we can move the existing README file to the wiki or some other setup file, and use the README to explain what it is we're trying to accomplish, with some screenshots and have a link to the documentation and a live demo.

Thoughts?
@project-bot project-bot bot added this to To do in MyLA-Default-Project Jul 19, 2019
@jonespm
Copy link
Member

jonespm commented Jul 20, 2019

Yeah redoing all of the documentation as you mention would be something that would be really nice to do just often hard to get time for. The existing docs might be out of date and are only updated whenever someone new comes along and lets us know about a problem.

@justin0022
Copy link
Collaborator Author

Okay I'll try to draft something up

@justin0022 justin0022 mentioned this issue Jul 23, 2019
Merged
@justin0022 justin0022 self-assigned this Jul 25, 2019
@justin0022
Copy link
Collaborator Author

Todo: add note about running the front-end in production mode.

@jennlove-um jennlove-um added the 📖 documentation Involves updates to the README, CONTRIBUTING, or other supporting text files label Sep 24, 2020
@jennlove-um
Copy link
Contributor

I'm closing this issue. This is addressed in #661

MyLA-Default-Project automation moved this from To do to Review/QA Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@justin0022 justin0022

Labels
📖 documentation Involves updates to the README, CONTRIBUTING, or other supporting text files 📈 enhancement New feature or request 🚧 in progress
Projects
MyLA-Default-Project
  
Review/QA
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jonespm @justin0022 @jennlove-um