Skip to content

General suggestions for improving template README docs #349

Open

Description

Suggestions for ToDo using Node.js

  • Aiding developers using template as foundation for their apps

    • Replace the README for the client app with a walkthrough of the client app
    • Replace the README for the server app with a walkthrough of the server app
  • Streamlining getting started

    • Include steps in core README to run project locally, as this will be the first step
    • If the developer is using containers, is Node.js required to be installed locally?
    • Ensure alt attributes are added to all images for accessibility
    • Make cleanup more visible to ensure developers don't get caught with a surprise bill
    • Consider breaking Next Steps section out to different page to shorten README page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions