Skip to content

Review public-facing GitHub docs #6

@cassidyjames

Description

@cassidyjames

I'd like to go through and make sure READMEs focus on being great "advertisements" in the context of community project documentation:

  1. Clear, concise description (what problem does it solve?)
  2. Why it's useful (and who it's for)
  3. How to contribute right now
  4. Showcase (screenshots, examples, demos)

I don't intend to go deleting anything, but it might mean moving things around a bit to ensure the top/front of the README is nice and clear.

Sub-issues

Metadata

Metadata

Assignees

Labels

GitHubRelated to our use of GitHub, e.g. repo names, READMEs, permissions, etc.documentationImprovements or additions to documentation

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions