close
Skip to content

Review and streamline contributor and developer documentation #57

Closed

Description

@jeffpaul

Description

Following on from the work in #42 and #53, let's review existing documentation files for clarity, conciseness, and proper organization. The goal is to simplify contributor onboarding, reduce duplication, and ensure each file serves a clear, distinct purpose.

Files to review

  • CONTRIBUTING.md
  • docs/DEVELOPER_GUIDE.md
  • docs/DEVELOPER_GUIDE.md
  • .github/SUPPORT.md

Goals

  • Simplify and shorten each document while keeping essential details.
  • Identify redundant or outdated content and remove or relocate it as appropriate.
  • Ensure each file’s purpose is clear (for example, contribution workflow vs. local dev setup vs. support process).
  • Add short cross-references in README.md so users can easily find the right document based on their need (contributing, developing, testing, or seeking support).

Acceptance criteria

  • Each reviewed file is shorter, clearer, and focused on a single topic.
  • Unnecessary or duplicate content is removed or consolidated.
  • README.md includes direct links to these documents with short one-line descriptions.
  • All links and file references verified to work correctly.

Activity

  1. added this to the 0.2.0 milestone on Oct 29, 2025
  2. added theissue type on Oct 29, 2025
  3. added
    [Type] TaskIssues or PRs that have been broken down into an individual action to take
    on Oct 29, 2025
  4. modified the milestones: 0.1.1, 0.2.0 on Dec 2, 2025
  5. pbearne commented on Jan 9, 2026

    @pbearne
    Contributor

    I can do this

  6. moved this from To do to Needs review in WordPress AI Roadmapon Jan 12, 2026
  7. hrishikesh2810 commented on Jan 13, 2026

    @hrishikesh2810

    Hi! I’d like to work on this — is anyone assigned?

  8. modified the milestones: 0.2.0, 0.3.0 on Jan 13, 2026
  9. pbearne commented on Jan 13, 2026

    @pbearne
    Contributor

    Hi! I’d like to work on this — is anyone assigned?

    Check the changes I have made tdo they make sense to you :-)
    In this pull request #169

  10. moved this from Needs review to Done in WordPress AI Roadmapon Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Good first issueGood for newcomers[Type] Developer DocumentationImprovements or additions to documentation[Type] TaskIssues or PRs that have been broken down into an individual action to take

Type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions