Skip to content

[Documentation] Update references in all docs to key standards #22

@ashleyshaw

Description

@ashleyshaw

name: "📚 Documentation"
about: "Request new documentation or propose updates/clarifications to existing docs."
title: "[Documentation] Update references in all docs to key standards"
labels: [documentation, standards, cross-reference]

What documentation is needed?

Update all docs to ensure they reference the following key organisational documents where relevant:

Why is this documentation important?

Consistent cross-referencing to guiding documents reduces ambiguity, aligns all contributors with standards, and ensures onboarding and code review are always grounded in the canonical sources.

Acceptance Criteria

  • Documentation is clear, accurate, and up-to-date
  • Follows WordPress documentation standards
  • Includes code examples/screenshots if applicable
  • Documentation is accessible and easy to find
  • Changelog entry prepared for PR if user-facing update

Additional Context

Consult organisational docs:


Definition of Ready (DoR)

  • Documentation need is clear and well-defined
  • Related docs/issues or files linked
  • Acceptance criteria listed
  • Estimate added if relevant
  • Milestone/release assigned (if applicable)

Definition of Done (DoD)

  • Documentation meets org standards and guidelines
  • Changelog entry prepared for PR (CHANGELOG.md)
  • Documentation reviewed for clarity and accessibility
  • Screenshots/code examples included if relevant
  • PR uses correct branch prefix (docs/)

Metadata

Metadata

Assignees

Priority

None yet

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions