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

Feature: Update App Documentation / README #3471

Closed
wants to merge 2 commits into from

Conversation

ChargrilledChook
Copy link
Member

@ChargrilledChook ChargrilledChook commented Oct 30, 2022

Because

WIP. Putting up early To get early feedback on overall direction

This PR

  • Updates README.md with app specific info and useful links
  • Updates env.sample

Issue

Closes #3470

@KevinMulhern KevinMulhern temporarily deployed to odin-review-app-pr-3471 October 30, 2022 04:46 Inactive
Copy link
Member Author

@ChargrilledChook ChargrilledChook left a comment

Choose a reason for hiding this comment

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

Obviously still WIP, but welcome any feedback / suggestions at this point. Overally shape of it is largely there, I think.

Comment on lines +34 to +51
### Core Frameworks and Libraries
- Ruby on Rails
- Tailwind CSS
- Webpacker / Shakapacker

### Notable Tools
- ViewComponent
- React
- Sidekiq
- Kramdown

### Testing and Linting
- RSpec
- Jest
- Rubocop
- Erblint
- ESLint

Copy link
Member Author

Choose a reason for hiding this comment

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

Seeing it now I feel like this is overkill, at least for the README. Perhaps better suited to the wiki or another doc.

Copy link
Member

Choose a reason for hiding this comment

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

I can see where you're coming from by feeling it's overkill. I can't think of another spot for it though 😅
There would be no harm in leaving it here imo

Copy link
Contributor

Choose a reason for hiding this comment

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

What about moving it to the CONTRIBUTING file under a new Tech we use section?


Created by [Erik Trautman](http://www.github.com/eriktrautman)
## Significant Contributors
_This should be kept, but should it be directly in the README or linked to from here?_
Copy link
Member Author

Choose a reason for hiding this comment

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

Thoughts? Should this be kept as is? Put into significant_contributors.md and linked to? Something else entirely? There's a few spots where this information is duplicated somewhat, especially with the hall of fame

Copy link
Member

Choose a reason for hiding this comment

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

We have an idea in the backlog for creating a team page which may be a nice replacement/ solution to all this duplication.

GOOGLE_CLIENT_ID: 1234
GOOGLE_CLIENT_SECRET: 1234
SPAM_DOMAINS: 'example.com, baddomain.com'
Copy link
Member Author

Choose a reason for hiding this comment

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

Couldn't see this referenced anywhere so took it out.

@ChargrilledChook ChargrilledChook temporarily deployed to odin-review-app-pr-3471 October 30, 2022 04:53 Inactive
@ChargrilledChook ChargrilledChook self-assigned this Oct 30, 2022
@ChargrilledChook ChargrilledChook added the Type: Documentation Involves an update to the documentation label Oct 30, 2022
@scheals
Copy link
Contributor

scheals commented Jan 15, 2023

@ChargrilledChook RE: running all the tests and such from the PR where you mentioned bin/test, perhaps this bit of Contributing.md can be changed to that:
image

@ChargrilledChook
Copy link
Member Author

Still planning on doing this but need to revisit, many suggestions / changes have been implemented in the Wiki

@KevinMulhern KevinMulhern deleted the feature/update-readme branch July 6, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Involves an update to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Improve README / Documentation
4 participants