Skip to content

[Feature] Improve README to fit documentation best practices #29

Description

@internetisaiah

Hi team, I've been a light phone user for a while and I'm happy this repo exists!

Anyways, I've been writing developer documentation full-time for several years now, and I'm hopping to offer my abilities to help improve the docs--starting with the README.md.

Some things I'd like to improve:

  • Simplify the lengths of sentences and paragraphs, where applicable
  • Improve heading names for clarity
  • Add a few more headings to help split up content more logically
  • General content fixes (like spelling, grammar, links, code styling, etc.)
  • Better in-page information architecture to reflect the end-user journey more clearly

I read in the contributing guide that you prefer PRs start as issues, which is why I'm creating this issue--but I fully intend on submitting the PR myself. That said, feel free to reject or accepted any combination of my submitted changes.

Note: I do not use LLMs in any way to write or create my content. My contributions purely reflect my years of experience as a technical writer.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions