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

Generate a README.md template #27

Open

benlinton opened this issue Jul 31, 2018 · 0 comments

Labels

feature

Contributor

benlinton commented Jul 31, 2018

Requirements

Generate a boilerplate README.md
And create a docs/ folder if one do not already exist
Add a few sample docs

Reasons to use a `docs` folder

To regenerate new content and review diffs
To see when sections of docs were last updated
To reuse impactful content between multiple projects
To quickly delete topics that do not apply to your project
To save Postman exports for apps with an API

Possible README sections or sample docs

Some ideas for sections to possibly include:

Example badges?
Server instances
Dependencies (languages, packages, and linux libs)
External services/apis (i.e. SES, Google Analytics, Rollbar, Skylight, etc.)
Analytics
Database
Developer notes
Devops / deployment
Feature toggling
Monitoring
Pull requests
Code of conduct
Security
Setup
Styleguide
Postman

Here's an example (private) repo for nicely organized documentation to use for reference:
https://github.com/tablexi/landscapehub-website

The text was updated successfully, but these errors were encountered:

benlinton added the feature label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment