Skip to content

Generate a README.md template #27

@benlinton

Description

@benlinton

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions