Update project documentation to match template.#478
Merged
Conversation
dcfd1b1 to
819c8a9
Compare
b7e2e12 to
c4842e2
Compare
c4842e2 to
706ce76
Compare
There was a problem hiding this comment.
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.
dblatcher
approved these changes
Apr 7, 2026
3053b70 to
b8c0c58
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
How can we measure success?
The tool is easier to understand for newcomers.