Skip to content

Update project documentation to match template.#478

Merged
SHession merged 5 commits intomainfrom
sh/improve-project-documentation
Apr 8, 2026
Merged

Update project documentation to match template.#478
SHession merged 5 commits intomainfrom
sh/improve-project-documentation

Conversation

@SHession
Copy link
Copy Markdown
Contributor

@SHession SHession commented Apr 1, 2026

What does this change?

Using the recommendations template and Claude for a first pass, I have generated some improved documentation for this project.

It should cover all the basic points and make the tool easier to reason about for newcomers. There is some guidance on writing effect documentation here: https://github.com/guardian/recommendations/blob/main/documentation.md#readme-template

Reviewers should be transparent about areas they found confusing or irrelevant. Identifying these areas in the documentation is the most helpful feedback an author can receive. It allows an author to consider their real audience and work with them to provide the right level of detail.

How can we measure success?

The tool is easier to understand for newcomers.

@SHession SHession force-pushed the sh/improve-project-documentation branch from dcfd1b1 to 819c8a9 Compare April 7, 2026 07:15
@SHession SHession self-assigned this Apr 7, 2026
@SHession SHession added the maintenance Departmental tracking: maintenance work, not a fix or a feature label Apr 7, 2026
@SHession SHession force-pushed the sh/improve-project-documentation branch from b7e2e12 to c4842e2 Compare April 7, 2026 09:40
@SHession SHession force-pushed the sh/improve-project-documentation branch from c4842e2 to 706ce76 Compare April 7, 2026 09:41
@SHession SHession marked this pull request as ready for review April 7, 2026 09:43
@SHession SHession requested a review from a team as a code owner April 7, 2026 09:43
@SHession SHession requested a review from Copilot April 7, 2026 09:43
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project’s README to follow the Guardian recommendations template, making the library’s purpose, onboarding steps, and supporting docs easier to navigate for new contributors and consumers.

Changes:

  • Replaces the existing README with a structured, templated format (intro/getting started/how it works/links/terminology).
  • Adds/organizes links to existing docs (quick-start, how-it-works, vision, ADRs) and adds a terminology glossary.
  • Expands local dev, testing, releasing, and local-consumption guidance (changesets + yalc).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@SHession SHession force-pushed the sh/improve-project-documentation branch from 3053b70 to b8c0c58 Compare April 8, 2026 06:53
@SHession SHession merged commit b5f3bd0 into main Apr 8, 2026
6 checks passed
@SHession SHession deleted the sh/improve-project-documentation branch April 8, 2026 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Departmental tracking: maintenance work, not a fix or a feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants